Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
125 changes: 74 additions & 51 deletions doc/install/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,20 +135,6 @@ You can then run the installer using
Finally, close your terminal window and open a new one to make the ``conda`` command
properly available.

Alternatively, if you have already installed Anaconda or Miniconda, make sure that you create your environment
with the "channel" set to "conda-forge", e.g. for a Python 3.13 environment:

.. code-block:: bash

conda create --name amuse_p313 python=3.13 --channel conda-forge --override-channels


which you activate in the usual way:

.. code-block:: bash

conda activate amuse_p313


.. _installing_amuse:

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

.. code-block:: bash

curl -L -O "https://github.com/amusecode/amuse/archive/refs/tags/v2025.5.0.tar.gz"
curl -L -O "https://github.com/amusecode/amuse/archive/refs/tags/v2025.9.0.tar.gz"


This ``.tar.gz`` file needs to be unpacked first (you may need to change the version if
you downloaded a newer one):

.. code-block:: bash

tar xf v2025.5.0.tar.gz
tar xf v2025.9.0.tar.gz


Then we can enter the directory with the AMUSE source code:

.. code-block:: bash

cd amuse-2025.5.0
cd amuse-2025.9.0


And then you can start the installer:
Expand All @@ -200,40 +186,6 @@ Slack <https://amusecode.slack.com>`_ or by `making an issue on
GitHub <https://github.com/amusecode/amuse/issues/new/choose>`_.


Installing from a Git repository
````````````````````````````````

If you plan to modify AMUSE or one of the codes in it, then you may want to install from
a local git clone instead of from a tar file. This will take more disk space and more
download time, so it shouldn't be the first option, but if you want to do it then you
can. You'll need to gave `git` installed:

.. code-block:: bash

git clone https://github.com/amusecode/amuse.git


Then you can enter the source directory using:

.. code-block:: bash

cd amuse


Select a version to build (use either one of these, or whichever version is relevant):

.. code-block:: bash

git switch main # current development version
git checkout checkout v2025.5.0 # tagged release

And now you can start the installer as before:

.. code-block:: bash

./setup


Additional packages
```````````````````

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


Debugging conda package installation
````````````````````````````````````

If you encounter problems with installing packages using ``conda``, or AMUSE doesn't
compile correctly, then you should check that you are using the ``conda-forge`` channel
rather than something else.

Conda can use different sources of packages, which it calls channels. Different channels
contain software packaged by different people, and packages from different channels are
often incompatible. If you type

.. code-block:: bash

conda list


then you should see a list of packages that are installed in the active environment, and
which channel they came from. Ideally, all of them have ``conda-forge`` as the channel.

If not, then you can reinstall the package from ``conda-forge`` and see if that improves
the situation.

To reinstall a package from ``conda-forge``, use

.. code-block:: bash

conda install -c conda-forge <package name>


If you want to combine AMUSE with another package that isn't available from conda-forge,
then you may have to install that from another channel, and hope that things work. Or
ask the maintainers of that package to add it to conda-forge and be a bit more
compatible with the rest of the world.


Alternative installation options
================================

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

.. _installing_from_git:

Installing from a Git repository
--------------------------------

If you plan to modify AMUSE or one of the codes in it, then you may want to install from
a local git clone instead of from a tar file. This will take more disk space and more
download time, so it shouldn't be the first option, but if you want to do it then you
can. You'll need to gave `git` installed:

.. code-block:: bash

git clone https://github.com/amusecode/amuse.git


Then you can enter the source directory using:

.. code-block:: bash

cd amuse


Select a version to build (use either one of these, or whichever version is relevant):

.. code-block:: bash

git switch main # current development version
git checkout checkout v2025.9.0 # tagged release

And now you can start the installer as before:

.. code-block:: bash

./setup


.. _using_a_virtualenv:

Using a virtualenv
Expand Down
118 changes: 0 additions & 118 deletions doc/reference/cuda-setup.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Reference documentation
legacy_support
message-protocol
distributed
cuda-setup
cartesius
slurm
style_guide
Expand Down
2 changes: 1 addition & 1 deletion support/setup/help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ or a Python virtualenv. If you have an environment into which you'd like to
install AMUSE, you should activate it now. To create a new Conda environment,
use

conda create -n Amuse-env
conda create --channel conda-forge --override-channels -n Amuse-env

Then you activate it using

Expand Down
Loading