Skip to content

Commit

Permalink
move specific version installation to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
StFroese committed Jan 13, 2023
1 parent df65bf4 commit 8f6fe5b
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,22 +61,18 @@ first, to isolate the installed version and dependencies from your master
environment (this is optional).


The following command will set up a conda virtual environment using mamba, add the
necessary package channels, and install ctapipe specified version and its dependencies::
The latest version of ``ctapipe`` can be installed via::

CTAPIPE_VER=0.17.0
wget https://raw.githubusercontent.com/cta-observatory/ctapipe/v$CTAPIPE_VER/environment.yml
mamba env create -n cta -f environment.yml
mamba activate cta
mamba install -c conda-forge ctapipe=$CTAPIPE_VER
mamba install -c conda-forge ctapipe

**Note**: this environment contains many useful packages that are not strictly requirements of ctapipe.
To get only ctapipe and its direct dependencies, just do ``mamba install -c conda-forge ctapipe[=<version>]`` in an environment
of your choice.
or via::

pip install ctapipe

**Note**: to install a specific version of ctapipe take look at the documentation `here <https://cta-observatory.github.io/ctapipe/getting_started_users>`_.

**Note**: ``mamba`` is a C++ reimplementation of conda and can be found `here <https://github.com/mamba-org/mamba>`_.

The file *environment.yml* can be found in this repo.
Note this is *pre-alpha* software and is not yet stable enough for end-users (expect large API changes until the first stable 1.0 release).

Developers should follow the development install instructions found in the
Expand Down
44 changes: 44 additions & 0 deletions docs/getting_started_users/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@

.. _getting_started_users:

*************************
Getting Started For Users
*************************

.. warning::

The following guide is for *users*. As of now this will just cover
the basic installation procedure. This guide will be extended in
the future.


------------------------
Get the ctapipe software
------------------------

+++++++++++++++++++++++++++++
How to get the latest version
+++++++++++++++++++++++++++++

We recommend using the ``mamba`` package manager, which is a C++ reimplementation of ``conda``.
It can be found `here <https://github.com/mamba-org/mamba>`_.
Once you created a new virtual environment, you can install ``ctapipe`` with the following command::

mamba install -c conda-forge ctapipe

or with pip::

pip install ctapipe


+++++++++++++++++++++++++++++
How to get a specific version
+++++++++++++++++++++++++++++

To install a specific version of ``ctapipe`` you can use the following command::
mamba install -c conda-forge ctapipe==0.17.0

or with pip::

pip install ctapipe==0.17.0
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ General documentation
:maxdepth: 1
:glob:

getting_started_users/index
getting_started/index
development/index
tutorials/index
Expand Down

0 comments on commit 8f6fe5b

Please sign in to comment.