The full documentation is available here
First install FEniCS
Then install dolfin-adjoint
with:
python3 -m pip install git+https://github.com/dolfin-adjoint/dolfin-adjoint.git@main
or using the Pypi-package for the latest stable release
python3 -m pip install dolfin-adjoint
If you found a bug, create an issue
We love pull requests from everyone.
Fork, then clone the repository:
git clone https://github.com/{your_username}/dolfin-adjoint.git
Make sure the tests pass:
python3 -m pytest tests
Make your change. Add tests for your change. Make the tests pass:
python3 -m pytest tests
Push to your fork and submit a pull request. At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Add Python doc-strings that follow the Google Style.
- Write good commit and pull request message.
This software is licensed under the GNU LGPL v3.