Skip to content

Commit

Permalink
update installation documentation for tardis (#2460)
Browse files Browse the repository at this point in the history
* update installation documentation for tardis by removing conda forge for non-developers and switching order of developers and non-developers

* adding Erin's information to mailmap

adding Erin's info to mailmap

* added requested code to lines 33 and 110

* changed release tag to latest

* moved download line order
  • Loading branch information
erinvisser authored Feb 9, 2024
1 parent f118e97 commit 38a8141
Showing 1 changed file with 20 additions and 24 deletions.
44 changes: 20 additions & 24 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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/[email protected]`

::

$ 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 <https://github.com/tardis-sn/tardis/fork>`_, configure
3. a. Developers should `fork the repository <https://github.com/tardis-sn/tardis/fork>`_, configure
GitHub to `work with SSH keys <https://docs.github.com/en/authentication/connecting-to-github-with-ssh>`_,
set up the `upstream remote <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork>`_,
and install the package in development mode.
Expand All @@ -78,7 +56,24 @@ this method by following the steps described below.
.. note::

The complete developer guidelines can be found :ref:`here <developer_guidelines>`.

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.

Expand Down Expand Up @@ -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::
Expand Down

0 comments on commit 38a8141

Please sign in to comment.