Skip to content

Commit 9d01e65

Browse files
authored
Add instructions on installing from a git clone to the docs (#1168)
1 parent a4927ae commit 9d01e65

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

doc/install/installing.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,40 @@ Slack <https://amusecode.slack.com>`_ or by `making an issue on
183183
GitHub <https://github.com/amusecode/amuse/issues/new/choose>`_.
184184

185185

186+
Installing from a Git repository
187+
````````````````````````````````
188+
189+
If you plan to modify AMUSE or one of the codes in it, then you may want to install from
190+
a local git clone instead of from a tar file. This will take more disk space and more
191+
download time, so it shouldn't be the first option, but if you want to do it then you
192+
can. You'll need to gave `git` installed:
193+
194+
.. code-block:: bash
195+
196+
git clone https://github.com/amusecode/amuse.git
197+
198+
199+
Then you can enter the source directory using:
200+
201+
.. code-block:: bash
202+
203+
cd amuse
204+
205+
206+
Select a version to build (use either one of these, or whichever version is relevant):
207+
208+
.. code-block:: bash
209+
210+
git switch main # current development version
211+
git checkout checkout v2025.5.0 # tagged release
212+
213+
And now you can start the installer as before:
214+
215+
.. code-block:: bash
216+
217+
./setup
218+
219+
186220
Additional packages
187221
```````````````````
188222

0 commit comments

Comments
 (0)