Contributing to this documentation

This documentation is by far not complete; we are continuously trying to improve it.

Note

If you have an idea how we can improve this documentation, please don’t hesitate to send your suggestions to lamos_it+aether@groups.uni-bremen.de.

Source repository

The sources to this documentation are located at code.iup.uni-bremen.de.

Creating the HTML pages

This documentation is written in reStructuredText, which is converted to HTML using the Sphinx framework. In order to create the HTML pages, the following Python packages have to be installed:

• Sphinx

• sphinx_rtd_theme

• sphinxcontrib-email

Python 2.x is required, as sphinxcontrib-email was written for Python 2.x. The actual build process is automated with the Makefile. For local testing, the command make html will create the HTML pages in the subdirectory _build/html/.

Publishing changes

For publishing the updated documentation, make upload can be used.

Open points

We have already foreseen the following points:

Todo

Complete list of datasets available on Aether

(The original entry is located in /home/mdan/WWW/aether-doc/datasets.rst, line 9.)

Todo

fix module-query examples

(The original entry is located in /home/mdan/WWW/aether-doc/quickstart.rst, line 120.)

Todo

check slurm defults for sbatch -tN

(The original entry is located in /home/mdan/WWW/aether-doc/slurm.rst, line 201.)

Todo

check if slurm defaults for stdout and stderr are correct

(The original entry is located in /home/mdan/WWW/aether-doc/slurm.rst, line 244.)

Todo

Add default values for SBATCH parameters

(The original entry is located in /home/mdan/WWW/aether-doc/slurm.rst, line 338.)