The official place to find materials from AiiDA tutorial events, interactive demos and videos.
Visit http://aiida-tutorials.readthedocs.org
We highly welcome contributions of
- links to new tutorial materials
- corrections of existing tutorial materials
If you would like to contribute a fix or a link to a new tutorial resource, please:
- Fork this repository
- Make your changes
- Submit a pull request
If you have a question, feel free to just open an issue.
- python 3.5 or greater
- pandoc
git clone https://github.com/aiidateam/aiida-tutorials.git
cd aiida-tutorials
pip install -r requirements.txt
pre-commit install # enable pre-commit hooks (optional)
cd docs/
make
# open build/html/index.html
Note that make
will run with the nitpick option, treating warnings as errors.
If you are updating the documentation and warnings are expected, run make html
instead.
This does not use the nitpick exception and will ensure that the documentation compiles despite the warnings.
This work is supported by the MARVEL National Centre for Competency in Research funded by the Swiss National Science Foundation, as well as by the MaX European Centre of Excellence funded by the Horizon 2020 EINFRA-5 program, Grant No. 676598.