Skip to content

Commit 971c88f

Browse files
authored
Merge pull request #1173 from HannoSpreeuw/1171_Fix
Fixes 1171: "Add guideline for Anaconda or Miniconda users"
2 parents 34f4736 + ec9c1b8 commit 971c88f

File tree

3 files changed

+30
-8
lines changed

3 files changed

+30
-8
lines changed

doc/install/installing.rst

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ To install AMUSE, we need to
1010
(AMUSE can also be installed without Conda if needed, as described below, but we
1111
recommend using Conda.)
1212

13-
If you have a Mac, then you should skip to :ref:`Setting up macOS`, and if you're
14-
running Linux then you can go straight to :ref:`Installing Conda`. For Windows, continue
13+
If you have a Mac, then you should skip to :ref:`setting_up_macOS`, and if you're
14+
running Linux then you can go straight to :ref:`installing_conda`. For Windows, continue
1515
here with installing WSL.
1616

1717
Installing WSL
@@ -55,9 +55,10 @@ updates. We can then install them using this:
5555
sudo apt -y upgrade
5656
5757
58-
Now you can continue with :ref:`Installing Conda`, using the Ubuntu terminal window to
58+
Now you can continue with :ref:`installing_conda`, using the Ubuntu terminal window to
5959
enter the instructions.
6060

61+
.. _setting_up_macOS:
6162

6263
Setting up macOS
6364
----------------
@@ -99,6 +100,7 @@ loaded, and then you're ready to install Conda.
99100
If you use Bash instead of zsh, then you'll need to edit ``.bashrc`` instead. When in
100101
doubt, you can safely edit both files to be sure.
101102

103+
.. _installing_conda:
102104

103105
Installing Conda
104106
----------------
@@ -108,10 +110,9 @@ available. Conda is a package manager, a program with which you can install othe
108110
programs. It's very widely used in science and beyond, so having a working Conda setup
109111
is very useful also outside of the world of AMUSE.
110112

111-
If you already have a working Conda setup, then you can continue to :ref:`Installing
112-
AMUSE`.
113+
If you already have a working Conda setup, then you can continue to :ref:`installing_amuse`.
113114

114-
If you cannot or don't want to use Conda, see :ref:`Using a virtualenv` below.
115+
If you cannot or don't want to use Conda, see :ref:`using_a_virtualenv` below.
115116

116117
If you do not yet have Conda, then you can install it using the following commands in
117118
the terminal. (Linux users can open one from the menu, Windows and macOS users will
@@ -134,6 +135,22 @@ You can then run the installer using
134135
Finally, close your terminal window and open a new one to make the ``conda`` command
135136
properly available.
136137

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+
152+
153+
.. _installing_amuse:
137154

138155
Installing AMUSE
139156
----------------
@@ -268,17 +285,18 @@ and then you can run it as before using
268285
269286
270287
You should now have a working AMUSE setup. To start
271-
using it, see :ref:`Getting started with AMUSE` or the :ref:`Interactive tutorial`
288+
using it, see :ref:`getting_started_with_amuse` or the :ref:`interactive_tutorial`
272289

273290

274291
Alternative installation options
275292
================================
276293

277294
The above instructions are the easiest way to install AMUSE, and they should work for
278295
almost everyone wanting to use AMUSE to do astrophysics. Nevertheless, there may be
279-
cases where you need a different setup, for example because you cannot use Conda. In
296+
cases where you need a different setup, for example because you cannot use Conda. In
280297
that case, you'll want one of these alternative installations.
281298

299+
.. _using_a_virtualenv:
282300

283301
Using a virtualenv
284302
------------------

doc/interactive_tutorial/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _interactive_tutorial:
2+
13
Interactive tutorial
24
====================
35

doc/tutorial/getting-started.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _getting_started_with_amuse:
2+
13
Getting started with AMUSE
24
==========================
35

0 commit comments

Comments
 (0)