This page provides guidance on how to contribute to DOLFINx. For information about how to get involved and how to get in touch with the developers, see our community page.
Adding a demo¶
The below instructions are for adding a Python demo program to DOLFINx.
DOLFINx demo programs are written in reStructuredText, and converted to
Python/C++ code using
pylit. The process for C++ demos is similar.
The documented demo programs are displayed at
Creating the demo program¶
Create a directory for the demo under
Write the demo in reStructuredText (rst), with the actual code in ‘code blocks’ (see other demos for guidance). The demo file should be named
Convert the rst file to to a Python file using
pylit(pylit is distributed with DOLFINx in
This will create a file
demo_foo-bar.py. Test that the Python script can be run.
Adding the demo to the documentation system¶
Add the demo to the list in
To check how the documentation will be displayed on the web, in
make htmland open the file
doc/build/html/index.htmlin a browser.
Make a pull request¶
Create a git branch and add the
demo_foo-bar.py.rstfile to the repository. Do not add the
If there is no C++ version, edit
test/regression/test.pyto indicate that there is no C++ version of the demo.
Make a pull request at https://github.com/FEniCS/dolfinx/ for your demo to be considered for addition to DOLFINx. Add the
demo_foo-bar.py.rstfile to the repository, but do not add the