|
|
The instructions below assume that your system fulfils the respective
|
|
|
[System Requirements](system-requirements). If you plan to just use the code
|
|
|
without modifying it, please follow one of the installation methods presented
|
|
|
in the [Regular Installation section](#regular-installation). However, if you
|
|
|
do plan to modify the code in any way, then please proceed as indicated in the
|
|
|
[Developer-Mode Installation section](#developer-mode-installation).
|
|
|
|
|
|
**N.B.:** In any case, you will be presented with instructions for installation
|
|
|
with and without MPI support. You only need to follow one set of such
|
|
|
instructions. Mind, however, the extra [System Requirements](system-requirements)
|
|
|
if you choose to install `netatmoqc` with MPI support.
|
|
|
|
|
|
|
|
|
#### Regular Installation
|
|
|
##### Regular Installation Directly From The Git Repo
|
|
|
|
|
|
:point_right: This is the way to go if you just want to use the code and don't
|
|
|
want to look at the source code at all.
|
|
|
|
|
|
* Install *without* MPI support:
|
|
|
|
|
|
pip install "git+https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc"
|
|
|
|
|
|
* Install with MPI support:
|
|
|
|
|
|
pip install "netatmoqc[mpi] @ git+https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc"
|
|
|
|
|
|
|
|
|
##### Regular Installation From Downloaded Source
|
|
|
|
|
|
:point_right: Choose this if you have `netatmoqc`'s source code in a local
|
|
|
directory and wish to install the code from there, but, at the same time, also
|
|
|
don't want to modify any of the source files.
|
|
|
|
|
|
* Install *without* MPI support:
|
|
|
|
|
|
pip install .
|
|
|
|
|
|
* Install with MPI support:
|
|
|
|
|
|
pip install ".[mpi]"
|
|
|
|
|
|
#### Developer Mode Installation
|
|
|
|
|
|
:point_right: This is for those who wish to make changes to `netatmoqc`'s source
|
|
|
code.
|
|
|
|
|
|
* Install *without* MPI support:
|
|
|
|
|
|
poetry install
|
|
|
|
|
|
* Install with MPI support:
|
|
|
|
|
|
poetry install --extras "mpi"
|
|
|
|
|
|
Installing in "developer mode" means that changes made in any of the package's
|
|
|
source files become visible as soon as the package is reloaded.
|
|
|
|
|
|
Before commiting your first set of modifications to the files on the repo,
|
|
|
please also run the following:
|
|
|
|
|
|
pre-commit install
|
|
|
|
|
|
The last step above only needs to be performed once within the repo's directory.
|
|
|
This sets up the git hook scripts defined in the
|
|
|
[.pre-commit-config.yaml](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/.pre-commit-config.yaml) file. |
|
|
\ No newline at end of file |