Skip to content

Commit

Permalink
Swapped notes about installing for developers with note about install…
Browse files Browse the repository at this point in the history
…ing compilers.
  • Loading branch information
uniomni committed Jun 1, 2023
1 parent 549dc6e commit b533cb1
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,32 +183,31 @@ and finally install ANUGA. Do a standard `pip` install
.. note::

You may need to install a compiler to complete the `pip install`.
You can use the system compilers or use `conda` to install compilers as such (for Linux and OSX):

.. code-block:: bash
conda install compilers
or for win32:
If you intend to develop ANUGA code then you should install ANUGA to be "editable". I.e.:

.. code-block:: bash
conda install m2w64-gcc libpython
pip install -e .
In this case the installation is "inplace" and "editable". You will be able to change and
develop code in the `anuga_core` directories. Note that if you change any `cython` or `C`
code you will need to run `pip install -e .` again for your changes to take effect.

.. note::

If you intend to develop ANUGA code then you should install ANUGA to be "editable". I.e.:
You may need to install a compiler to complete the `pip install`.
You can use the system compilers or use `conda` to install compilers as such (for Linux and OSX):

.. code-block:: bash
pip install -e .
conda install compilers
In this case the installation is "inplace" and "editable". You will be able to change and
develop code in the `anuga_core` directories. Note that if you change any `cython` or `C`
code you will need to run `pip install -e .` again for your changes to take effect.
or for win32:

.. code-block:: bash
conda install m2w64-gcc libpython
Finally it is sensible to test the installation.

Expand Down

0 comments on commit b533cb1

Please sign in to comment.