🚀 Features
- *(package)* Implement first version of eikonax, issue with softmin
- *(package)* Implement first partial derivatives
- *(test)* Use fim-python as reference
- *(preprocessing)* Make mesh generation more flexible
- *(solver)* Implement option for soft updates
- *(core)* Make small improvements and fixes to core lib
- *(app)* Make new example notebooks
- *(package)* Implement strong type system with jaxtyping and beartype
- *(package)* Make interface argument types more liberal
- *(core)* Implement finite difference routines
- *(package)* Implement hard update option for derivative, implement FD example in notebook
- *(project management)* Switch to UV, update dependencies
🐛 Bug Fixes
- *(corefunctions)* Fix computation for softminmax transformation of update parameters
- *(docs, derivator)* Extend doc strings, fix small bug in derivative solver
- *(derivator)* Fix minor bugs
- *(solver)* Fix soft update functions
- *(tensor field)* Switch to inverse tensor field
- *(core functions)* Fix bug in soft minmax function
- *(package)* Minor bug fixes and refactoring
- *(docs)* FIx type hints in doc strinjgs
- *(test)* Fix small bug in integration test setup
- *(ci)* Refactor github workflows for tagged commited
- *(ci)* Fix release workflow
💼 Other
- *(project)* Set up project structure and dependencies with uv
- *(package)* Switch to pixi project management
- *(hatch)* Enable dynamic versioning from git tags
🚜 Refactor
- *(package)* Implement logging, robust programming, different loop types, info output, new softmin based on boltzmann operator
- *(types)* Switch to official jax and numpy type hints
- *(test)* Refactor entire test suite to make it more DRY and distinguish between unit and integration tests
📚 Documentation
- *(core functions)* Add docstrings to core function module
- *(package)* Add further docstrings
- *(package)* Add further docstrings
- *(package)* Set up documentation with MKDocs
- *(API)* Add API docs
- *(API)* Add more API docs
- *(package)* Restructure docs, write readme
- *(build)* Add built documentation to tracking, until github actions is set up
- *(landing)* Update readme and doc index
- *(usage)* Add code snippets to tutorial docs
- *(package)* Add more documentation
- *(API)* Finish first version of API documentation
- *(readme)* Add landing page docs
- *(readme)* Add new icons to Github readme
- *(readme)* Add callout to Github Readme
- *(readme)* Edit onboarding docs
- *(mkdocs)* Remove source/build structure
- *(deploy)* Add github action for mkdocs build
- *(readme)* Update link to documentation
- *(onboarding)* Fix typo
- *(readme)* Add doc build status badge
- *(readme)* Add JAX badge
- *(changelog)* Set up git-cliff for changelog creation
- *(changelog)* Add first changelog and vscode config
- *(changelog)* Create new changelog for first release
🎨 Styling
- *(package)* Format source code
- *(types)* Use more descriptive type names, correct docstrings
🧪 Testing
- *(package)* Set up framework for testing
- *(core)* Implement unit tests
- *(unit)* Finish unit tests
- *(integration)* Add integration tests for forward solve on unit square
- *(integration)* Implement integration test for partial derivatives
- *(cov)* Configure coverage to exclude logging
- *(integration)* Check consistency of different solver types
- *(integration)* Implement tests for parametric derivatives
⚙️ Miscellaneous Tasks
- *(package)* Small code clean-up
- *(apps)* Move example into own folder
- *(package)* Add license file (GNU GPL)
- *(config)* Add project info to pyproject.toml
- *(setup)* Restructure dependencies
- *(format)* Implement GH action for Ruff and Pytest
- *(uv)* Enable more efficient caching for UV dependencies in CI
- *(UV)* Fix bug in uv caching
- *(test)* Testcontrol flow for Pytest
- *(fix)* Remove invalid dependent job
- *(test)* Add Pytest to ci action
- *(ecosystem)* Improve workflows, add new license badge
- *(ecosystem)* Add badges
- *(docs)* Rewrite doc workflow
- Add workflow for release, refactor other workflows
- New release workflow
- *(release)* Add correct conditional for tagged commits
- Refactor all workflows for release
- *(uv)* Update release workflow, remove global changelog