How to showcase your own project

Contributions are very welcomed - this can include pointing out typos, suggestion places were the description should be improved, providing this improvement, and so on. In addition we would like to showcase what user have used this package for, by adding sections to the User Projects chapter:

To do this provide us with a file projectname_descr.rst with a short description of your project with the authors and links to the project web page, journal article and so on. The following is an example taken from the description file of the vem project

########################################################
*dune-vem*: implementation of the virtual element method
########################################################

.. sectionauthor:: Andreas Dedner <a.s.dedner@warwick.ac.uk>, Martin Nolte <nolte.mrtn@gmail.com>

This module is based on DUNE-FEM
(https://gitlab.dune-project.org/dune-fem/dune-fem)
and provides implementation for the Virtual Element Method. The methods and
a Python frontend based on the new Python extension to DUNE
(https://gitlab.dune-project.org/staging/dune-python)
is available in the
https://gitlab.dune-project.org/dune-fem/dune-vem.

The vemdemo.rst file can be automatically generated by downloading our conversion script. It takes the name of a python script file as argument, generates a jupyter notebook and the restructured text file. So running bash nbscript2rst.sh projectname.py will generate the files projectname.ipynb, projectname.rst, and image files in the folder projectname_files. Send us these files in addition to the description file (e.g. as a tar.gz file) and that’s it. You can also fork this repo and set up a pull request.

Your python script file myproject.py can contain both markdown parts for additional descriptions between python code blocks similar to a jupyter notebook (see e.g. the script for the virtual element project). This file will be translated into a jupyter notebook which will also be made available for download. And then the sphinx extension nbsphinx is used to generate the restructured text file used in the documentation. The syntax for combining markdown cells and python code is straightforward:

If you have any questions or something in unclear let us know!