Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: how to run FESTIM in parallel #856 #871

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/userguide/beginners_guide.rst
Original file line number Diff line number Diff line change
@@ -12,6 +12,12 @@ New users should familiarise themselves with `Conda <https://anaconda.org/>`_.

FESTIM is under version control with `git <https://git-scm.com/>`_. Even though users don't need git to install FESTIM, it is convenient to understand how it works. You can find `git tutorials <https://git-scm.com/doc>`_ to help you getting started. The `FESTIM source code <https://github.com/festim-dev/FESTIM>`_ is hosted on GitHub. Signing up for free to GitHub is recommended to receive the latest updates, follow the development and submit `bug reports <https://github.com/festim-dev/FESTIM/issues/new/choose>`_.

FESTIM can be run in parallel on N cores using the command:

.. testcode::
XinShen-CHN marked this conversation as resolved.
Show resolved Hide resolved

mpirun -np N python3 your_FESTIM_script.py.

----------------------
Where can I find help?
----------------------
Loading