File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -170,3 +170,56 @@ individual codes can be build with:
170170 make {code}.code
171171
172172with {code} the name of the code in lower case.
173+
174+ Installation on HPC systems using modules (tested for Snellius)
175+ ***************************************************************
176+
177+ Note that the modules on your local HPC system may be differently named.
178+
179+ .. code-block:: sh
180+
181+ module load 2022
182+ module load foss/2022a
183+
184+ Load python.
185+
186+ .. code-block:: sh
187+
188+ module load Python/3.10.4-GCCcore-11.3.0 # or another version of python, 3.7 or higher
189+
190+
191+ Following AMUSE documentation (see above), download/upgrade the python package: (--user is required by Snellius)
192+
193+ .. code-block:: sh
194+
195+ mkdir MY_PROJECT_DIR
196+ cd MY_PROJECT_DIR
197+ python3 -m venv env # initialise a Python virtual environment, which will contain all the packages we install
198+ source env/bin/activate # activate the virtual environment - this must be repeated every time you log in
199+ pip install --upgrade pip
200+ cd AMUSE_DIR # change to where you downloaded AMUSE
201+ pip install -r requirements.txt --upgrade # install/upgrade all required packages
202+ pip install matplotlib # not required but highly recommended
203+ pip install -e .
204+
205+ Now you can build the AMUSE framework with
206+
207+ .. code-block:: sh
208+
209+ make framework
210+
211+ Finally, build AMUSE individual codes by running from the AMUSE directory:
212+
213+ .. code-block:: sh
214+
215+ make {code}.code
216+
217+ When you log in again (and in your SLURM scripts), you will need to load the same modules and activate the same environment:
218+
219+ .. code-block:: sh
220+
221+ module load 2022
222+ module load foss/2022a
223+ module load Python/3.10.4-GCCcore-11.3.0 # or another version of python, 3.7 or higher
224+ cd MY_PROJECT_DIR
225+ source env/bin/activate
You can’t perform that action at this time.
0 commit comments