Skip to content

Commit

Permalink
Update installation.rst
Browse files Browse the repository at this point in the history
Updated installation instructions for developers with the correct GitHub commands.
  • Loading branch information
uniomni committed Jun 1, 2023
1 parent f168288 commit 541e1db
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ Install ANUGA from source (e.g. as a developer) using MiniForge (Ubuntu)
------------------------------------------------------------------------

If you want to use the very latest version of ANUGA (or develop ANUGA code) then you need
to download the `anuga_core` repository from `github` and then `pip` install ANUGA from the source.
to download the `anuga_core` repository from `github` and then `pip` install ANUGA from the source.


First install the latest version of `Miniforge` as described in section `Install MiniForge`_.

Expand All @@ -157,6 +158,14 @@ Now we need to download the ANUGA source code from `github`
This creates a directory `anuga_core`.


If you want to also contribute to the code base, you must have a GitHub account and setup authentication from your developer workstation to GitHub as per these instructions: https://docs.github.com/en/authentication/managing-commit-signature-verification
The command to clone ANUGA as a developer is then

.. code-block:: bash
git clone git@github.com:anuga-community/anuga_core.git
Now create and activate a `conda` environment with ANUGA's current dependencies as
defined in the file `environment.yml`

Expand Down

0 comments on commit 541e1db

Please sign in to comment.