diff --git a/docs/installation.rst b/docs/installation.rst index 8c2c54a956b..b91653967ac 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -30,7 +30,7 @@ this method by following the steps described below. :: - $ wget -q https://github.com/tardis-sn/tardis/releases/latest/download/conda-{platform}-64.lock + $ wget -q https://github.com/tardis-sn/tardis/blob/master/conda-{platform}-64.lock 2. Create and activate the ``tardis`` environment. @@ -39,29 +39,7 @@ this method by following the steps described below. $ conda create --name tardis --file conda-{platform}-64.lock $ conda activate tardis -3. a. Non-developers can install the latest release from ``conda-forge`` with the ``--no-deps`` flag, - - .. warning:: - - Currently the conda forge installation doesn't work. It's recommended to install from the specific releases using pip- - - `$ pip install git+https://github.com/tardis-sn/tardis.git@{tag}` - - For example- - - `pip install git+https://github.com/tardis-sn/tardis.git@release-2023.09.17` - - :: - - $ conda install tardis-sn --channel conda-forge --no-deps - - or trying the most recent, unreleased changes from upstream. - - :: - - $ pip install git+https://github.com/tardis-sn/tardis.git@master - - b. Instead, developers should `fork the repository `_, configure +3. a. Developers should `fork the repository `_, configure GitHub to `work with SSH keys `_, set up the `upstream remote `_, and install the package in development mode. @@ -78,7 +56,24 @@ this method by following the steps described below. .. note:: The complete developer guidelines can be found :ref:`here `. + + b. Non-developers can install from specific releases using pip- + + :: + + $ pip install git+https://github.com/tardis-sn/tardis.git@{tag} + + For example- + + :: + + $ pip install git+https://github.com/tardis-sn/tardis.git@release-latest + + or trying the most recent, unreleased changes from upstream. + :: + + $ pip install git+https://github.com/tardis-sn/tardis.git@master 4. Once finished working, you can deactivate your environment. @@ -111,6 +106,7 @@ To update the environment after a new release, download the latest lockfile and :: + $ wget -q https://github.com/tardis-sn/tardis/releases/latest/download/conda-{platform}-64.lock $ conda update --name tardis --file conda-{platform}-64.lock .. note::