Skip to content

Commit

Permalink
New links in documentation for the ATES wrapper
Browse files Browse the repository at this point in the history
  • Loading branch information
ladsantos committed Mar 2, 2024
1 parent c71d91d commit a829f1c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Requirements

If you wish to use the ATES wrapper in the `fluid` module, further requirements are necessary:
* A Fortran compiler: either `gfortran` or `ifort` needs to be available in your PATH
* The **custom version** of ATES forked from the [original](https://github.com/AndreaCaldiroli/ATES-Code) and available [here](https://github.com/ladsantos/ATES-Code). The wrapper in the `fluid` module will not work with the original ATES code, only with the custom version.
* The **custom version** of ATES forked from the [original](https://github.com/AndreaCaldiroli/ATES-Code) and available [here](https://github.com/ladsantos/ATES-Code/releases). The wrapper in the `fluid` module will not work with the original ATES code, only with the custom version.

Installation
------------
Expand Down Expand Up @@ -67,7 +67,7 @@ pytest tests

### Download the custom ATES code and set environment variable

If you wish to use the ATES wrapper available in the `fluid` module, you will need to download a custom ATES code [here](https://github.com/ladsantos/ATES-Code). The wrapper is not compatible with the original ATES code.
If you wish to use the ATES wrapper available in the `fluid` module, you will need to download a custom ATES code [here](https://github.com/ladsantos/ATES-Code/releases). The wrapper is not compatible with the original ATES code.

After downloading it, you will need to set the environment variable `$ATES_DIR` to the location of the ATES code in your computer. For this example, I will use `$HOME/ATES-Code`. This is done by running the following code in the command line:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Installation
============

``p-winds`` requires the packages ``numpy``, ``scipy``, ``astropy``, and
``flatstar`` for running its core calculations. For hydrodyamic simulations with the ATES wrapper, ``p-winds`` also requires a Fortran compiler (either ``gfortran`` or ``ifort``) and a custom version of the ATES code available for download `here <https://github.com/ladsantos/ATES-Code>`_.
``flatstar`` for running its core calculations. For hydrodyamic simulations with the ATES wrapper, ``p-winds`` also requires a Fortran compiler (either ``gfortran`` or ``ifort``) and a custom version of the ATES code available for download `here <https://github.com/ladsantos/ATES-Code/releases>`_.

Option 1: Using ``pip`` (stable version)
--------------------------------------------------------------
Expand Down Expand Up @@ -38,7 +38,7 @@ install ``pytest`` first):
Download the custom ATES code and set environment variable
----------------------------------------------------------

If you wish to use the ATES wrapper available in the ``fluid`` module, you will need to download a custom ATES code `here <https://github.com/ladsantos/ATES-Code>`_. The wrapper is not compatible with the original ATES code.
If you wish to use the ATES wrapper available in the ``fluid`` module, you will need to download a custom ATES code `here <https://github.com/ladsantos/ATES-Code/releases>`_. The wrapper is not compatible with the original ATES code.

After downloading it, you will need to set the environment variable ``$ATES_DIR`` to the location of the ATES code in your computer. For this example, I will use ``$HOME/ATES-Code``. This is done by running the following code in the command line:

Expand Down

0 comments on commit a829f1c

Please sign in to comment.