Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation instruction using conda forge and badge to README #1148

Merged
merged 3 commits into from
Jul 27, 2023
Merged

Add installation instruction using conda forge and badge to README #1148

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01cac08
add installation instruction from conda forge
morcuended Jul 27, 2023
86af096
add conda forge channel
morcuended Jul 27, 2023
e3368bd
suggest mamba
morcuended Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# cta-lstchain [![Build Status](https://github.com/cta-observatory/cta-lstchain/workflows/CI/badge.svg?branch=main)](https://github.com/cta-observatory/cta-lstchain/actions?query=workflow%3ACI+branch%3Amain) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6344673.svg)](https://doi.org/10.5281/zenodo.6344673) [![PyPI version](https://badge.fury.io/py/lstchain.svg)](https://badge.fury.io/py/lstchain)
# cta-lstchain [![Build Status](https://github.com/cta-observatory/cta-lstchain/workflows/CI/badge.svg?branch=main)](https://github.com/cta-observatory/cta-lstchain/actions?query=workflow%3ACI+branch%3Amain) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6344673.svg)](https://doi.org/10.5281/zenodo.6344673) [![PyPI version](https://badge.fury.io/py/lstchain.svg)](https://badge.fury.io/py/lstchain) [![Conda version](https://anaconda.org/conda-forge/lstchain/badges/version.svg)](https://anaconda.org/conda-forge/lstchain)

Repository for the high level analysis of the LST.
The analysis is heavily based on [ctapipe](https://github.com/cta-observatory/ctapipe), adding custom code for mono reconstruction.
Expand All @@ -12,20 +12,27 @@ are unit tested and should be working as long as the build status is passing.

## Install

- You will need to install [miniconda](https://docs.conda.io/en/latest/miniconda.html) (recommended) or [anaconda](https://www.anaconda.com/distribution/#download-section) first.
You will need to install [micromamba/mamba](https://mamba.readthedocs.io/en/latest/installation.html) (recommended), [miniconda](https://docs.conda.io/en/latest/miniconda.html) or [anaconda](https://www.anaconda.com/distribution/#download-section) first.


### As user

You can create an environment and install `lstchain` from conda-forge as:
```
LSTCHAIN_VER=0.10.0 (or the version you want to install - usually the latest release)
mamba create -c conda-forge -n lstchain-v0.10.3 python=3.11 lstchain=0.10.3
```

Alternatively, you can also install `lstchain` from PyPi with `pip`:
```
LSTCHAIN_VER=0.10.3 (or the version you want to install - usually the latest release)
wget https://raw.githubusercontent.com/cta-observatory/cta-lstchain/v$LSTCHAIN_VER/environment.yml
conda env create -n lst -f environment.yml
conda activate lst
pip install lstchain==$LSTCHAIN_VER
rm environment.yml
```


### As developer

- Create and activate the conda environment:
Expand All @@ -41,7 +48,7 @@ conda activate lst-dev
conda env config vars set PYTHONNOUSERSITE=1 -n <environment_name>
```

To update the environment (e.g. when depenencies got updated), use:
To update the environment (e.g. when dependencies got updated), use:
```
conda env update -n lst-dev -f environment.yml
```
Expand Down
Loading