Commit 7c081c6a authored by Philipp Arras's avatar Philipp Arras
Browse files

Add contributing section

parent 7f5df2b7
......@@ -88,7 +88,7 @@ MPI support is added via:
sudo apt-get install python3-mpi4py
### Running the tests
### Run the tests
To run the tests, additional packages are required:
......@@ -107,19 +107,10 @@ dive into NIFTy by running one of the demonstrations, e.g.:
python3 demos/getting_started_1.py
### Building the documentation from source
To build the documentation from source, install
[sphinx](https://www.sphinx-doc.org/en/stable/index.html) and the
[Read The Docs Sphinx Theme](https://github.com/readthedocs/sphinx_rtd_theme)
on your system and run
sh docs/generate.sh
### Acknowledgements
Please acknowledge the use of NIFTy in your publication(s) by using a
phrase such as the following:
Please consider acknowledging NIFTy in your publication(s) by using a phrase
such as the following:
> "Some of the results in this publication have been derived using the
> NIFTy package [(https://gitlab.mpcdf.mpg.de/ift/NIFTy)](https://gitlab.mpcdf.mpg.de/ift/NIFTy)"
......@@ -134,15 +125,6 @@ The NIFTy package is licensed under the terms of the
*without any warranty*.
Contributing
------------
Please note our convention not to use pure Python `assert` statements in
production code. They are not guaranteed to by executed by Python and can be
turned off by the user (`python -O` in cPython). As an alternative use
`ift.myassert`.
Contributors
------------
......
Contributing to NIFTy
=====================
Coding conventions
------------------
We do not to use pure Python `assert` statements in production code. They are
not guaranteed to by executed by Python and can be turned off by the user
(`python -O` in cPython). As an alternative use `ift.myassert`.
Build the documentation
-----------------------
To build the documentation from source, install `sphinx
<https://www.sphinx-doc.org/en/stable/index.html>`_ and the `pydata sphinx theme
<https://github.com/readthedocs/sphinx_rtd_theme>`_ on your system and run
sh docs/generate.sh
NIFTy Manual
============
Welcome to the nifty7 documentation!
.. toctree::
:maxdepth: 1
User Guide <user/index>
API reference <mod/nifty7>
Development <dev/index>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment