From 8f6fe5bd643c9584f95c730f5373a939fe7e5f21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Fr=C3=B6se?= Date: Thu, 12 Jan 2023 15:23:13 +0100 Subject: [PATCH] move specific version installation to docs --- README.rst | 18 +++++------- docs/getting_started_users/index.rst | 44 ++++++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 52 insertions(+), 11 deletions(-) create mode 100644 docs/getting_started_users/index.rst diff --git a/README.rst b/README.rst index b1db125d42f..43bebc49ae9 100644 --- a/README.rst +++ b/README.rst @@ -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[=]`` 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 `_. **Note**: ``mamba`` is a C++ reimplementation of conda and can be found `here `_. -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 diff --git a/docs/getting_started_users/index.rst b/docs/getting_started_users/index.rst new file mode 100644 index 00000000000..4dd9cf6cbe7 --- /dev/null +++ b/docs/getting_started_users/index.rst @@ -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 `_. +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 diff --git a/docs/index.rst b/docs/index.rst index 90c43ecb2ef..9f5dd99a5de 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,6 +40,7 @@ General documentation :maxdepth: 1 :glob: + getting_started_users/index getting_started/index development/index tutorials/index