Skip to content

Commit 57cc1ff

Browse files
authored
Merge pull request #1178 from LourensVeen/update-install-docs
Update install docs
2 parents c423867 + 97c675f commit 57cc1ff

4 files changed

Lines changed: 75 additions & 171 deletions

File tree

doc/install/installing.rst

Lines changed: 74 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -135,20 +135,6 @@ You can then run the installer using
135135
Finally, close your terminal window and open a new one to make the ``conda`` command
136136
properly available.
137137

138-
Alternatively, if you have already installed Anaconda or Miniconda, make sure that you create your environment
139-
with the "channel" set to "conda-forge", e.g. for a Python 3.13 environment:
140-
141-
.. code-block:: bash
142-
143-
conda create --name amuse_p313 python=3.13 --channel conda-forge --override-channels
144-
145-
146-
which you activate in the usual way:
147-
148-
.. code-block:: bash
149-
150-
conda activate amuse_p313
151-
152138

153139
.. _installing_amuse:
154140

@@ -162,22 +148,22 @@ command in your terminal to download it as above, for example:
162148

163149
.. code-block:: bash
164150
165-
curl -L -O "https://github.com/amusecode/amuse/archive/refs/tags/v2025.5.0.tar.gz"
151+
curl -L -O "https://github.com/amusecode/amuse/archive/refs/tags/v2025.9.0.tar.gz"
166152
167153
168154
This ``.tar.gz`` file needs to be unpacked first (you may need to change the version if
169155
you downloaded a newer one):
170156

171157
.. code-block:: bash
172158
173-
tar xf v2025.5.0.tar.gz
159+
tar xf v2025.9.0.tar.gz
174160
175161
176162
Then we can enter the directory with the AMUSE source code:
177163

178164
.. code-block:: bash
179165
180-
cd amuse-2025.5.0
166+
cd amuse-2025.9.0
181167
182168
183169
And then you can start the installer:
@@ -200,40 +186,6 @@ Slack <https://amusecode.slack.com>`_ or by `making an issue on
200186
GitHub <https://github.com/amusecode/amuse/issues/new/choose>`_.
201187

202188

203-
Installing from a Git repository
204-
````````````````````````````````
205-
206-
If you plan to modify AMUSE or one of the codes in it, then you may want to install from
207-
a local git clone instead of from a tar file. This will take more disk space and more
208-
download time, so it shouldn't be the first option, but if you want to do it then you
209-
can. You'll need to gave `git` installed:
210-
211-
.. code-block:: bash
212-
213-
git clone https://github.com/amusecode/amuse.git
214-
215-
216-
Then you can enter the source directory using:
217-
218-
.. code-block:: bash
219-
220-
cd amuse
221-
222-
223-
Select a version to build (use either one of these, or whichever version is relevant):
224-
225-
.. code-block:: bash
226-
227-
git switch main # current development version
228-
git checkout checkout v2025.5.0 # tagged release
229-
230-
And now you can start the installer as before:
231-
232-
.. code-block:: bash
233-
234-
./setup
235-
236-
237189
Additional packages
238190
```````````````````
239191

@@ -288,6 +240,41 @@ You should now have a working AMUSE setup. To start
288240
using it, see :ref:`getting_started_with_amuse` or the :ref:`interactive_tutorial`
289241

290242

243+
Debugging conda package installation
244+
````````````````````````````````````
245+
246+
If you encounter problems with installing packages using ``conda``, or AMUSE doesn't
247+
compile correctly, then you should check that you are using the ``conda-forge`` channel
248+
rather than something else.
249+
250+
Conda can use different sources of packages, which it calls channels. Different channels
251+
contain software packaged by different people, and packages from different channels are
252+
often incompatible. If you type
253+
254+
.. code-block:: bash
255+
256+
conda list
257+
258+
259+
then you should see a list of packages that are installed in the active environment, and
260+
which channel they came from. Ideally, all of them have ``conda-forge`` as the channel.
261+
262+
If not, then you can reinstall the package from ``conda-forge`` and see if that improves
263+
the situation.
264+
265+
To reinstall a package from ``conda-forge``, use
266+
267+
.. code-block:: bash
268+
269+
conda install -c conda-forge <package name>
270+
271+
272+
If you want to combine AMUSE with another package that isn't available from conda-forge,
273+
then you may have to install that from another channel, and hope that things work. Or
274+
ask the maintainers of that package to add it to conda-forge and be a bit more
275+
compatible with the rest of the world.
276+
277+
291278
Alternative installation options
292279
================================
293280

@@ -296,6 +283,42 @@ almost everyone wanting to use AMUSE to do astrophysics. Nevertheless, there may
296283
cases where you need a different setup, for example because you cannot use Conda. In
297284
that case, you'll want one of these alternative installations.
298285

286+
.. _installing_from_git:
287+
288+
Installing from a Git repository
289+
--------------------------------
290+
291+
If you plan to modify AMUSE or one of the codes in it, then you may want to install from
292+
a local git clone instead of from a tar file. This will take more disk space and more
293+
download time, so it shouldn't be the first option, but if you want to do it then you
294+
can. You'll need to gave `git` installed:
295+
296+
.. code-block:: bash
297+
298+
git clone https://github.com/amusecode/amuse.git
299+
300+
301+
Then you can enter the source directory using:
302+
303+
.. code-block:: bash
304+
305+
cd amuse
306+
307+
308+
Select a version to build (use either one of these, or whichever version is relevant):
309+
310+
.. code-block:: bash
311+
312+
git switch main # current development version
313+
git checkout checkout v2025.9.0 # tagged release
314+
315+
And now you can start the installer as before:
316+
317+
.. code-block:: bash
318+
319+
./setup
320+
321+
299322
.. _using_a_virtualenv:
300323

301324
Using a virtualenv

doc/reference/cuda-setup.rst

Lines changed: 0 additions & 118 deletions
This file was deleted.

doc/reference/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Reference documentation
2626
legacy_support
2727
message-protocol
2828
distributed
29-
cuda-setup
3029
cartesius
3130
slurm
3231
style_guide

support/setup/help.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ or a Python virtualenv. If you have an environment into which you'd like to
107107
install AMUSE, you should activate it now. To create a new Conda environment,
108108
use
109109
110-
conda create -n Amuse-env
110+
conda create --channel conda-forge --override-channels -n Amuse-env
111111
112112
Then you activate it using
113113

0 commit comments

Comments
 (0)