Skip to content

Commit c0f2607

Browse files
authored
Update README.md
- update codacy badge - update abstract - update dev instructions
1 parent fea0067 commit c0f2607

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
[![ci](https://github.com/cta-observatory/lstosa/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/cta-observatory/lstosa/actions/workflows/ci.yml)
44
[![Documentation Status](https://readthedocs.org/projects/lstosa/badge/?version=latest)](https://lstosa.readthedocs.io/en/latest/?badge=latest)
55
[![coverage](https://codecov.io/gh/cta-observatory/lstosa/branch/main/graph/badge.svg?token=Zjk1U1ytaG)](https://codecov.io/gh/cta-observatory/lstosa)
6-
[![quality](https://app.codacy.com/project/badge/Grade/a8743a706e7c45fc989d5ebc4d61d54f)](https://www.codacy.com/gh/cta-observatory/lstosa/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cta-observatory/lstosa&utm_campaign=Badge_Grade)
6+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a8743a706e7c45fc989d5ebc4d61d54f)](https://app.codacy.com/gh/cta-observatory/lstosa/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
77
[![pypi](https://img.shields.io/pypi/v/lstosa)](https://pypi.org/project/lstosa/)
88
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6567234.svg)](https://doi.org/10.5281/zenodo.6567234)
99

1010

11-
Prototype onsite processing pipeline for the Large Size Telescope prototype (LST-1) of [CTA](https://www.cta-observatory.org/) (Cherenkov Telescope Array) based on [cta-lstchain](https://github.com/cta-observatory/cta-lstchain) running on the LST-1 IT onsite center at ORM (La Palma, Spain). It automatically carries out the next-day analysis of observed data using cron jobs, parallelizing the processing using the job scheduler SLURM. It provides data quality monitoring and tracking of analysis products' provenance.
12-
Moreover, it also massively reprocesses the entire LST-1 dataset with each cta-lstchain major release:
11+
Onsite processing pipeline for the Large-Sized Telescope prototype (LST-1) of [CTAO](https://www.cta-observatory.org/) (Cherenkov Telescope Array Observatory) based on [cta-lstchain](https://github.com/cta-observatory/cta-lstchain) running on the LST-1 IT onsite data center at Observatorio Roque de los Muchachos (La Palma, Spain). It automatically carries out the next-day analysis of observed data using cron jobs, parallelizing the processing using the job scheduler SLURM. It provides data quality monitoring and tracking of analysis products' provenance. Moreover, it also massively reprocesses the entire LST-1 dataset with each cta-lstchain major release.
12+
1313
- Code: <https://github.com/cta-observatory/lstosa>
1414
- Docs: <https://lstosa.readthedocs.io/>
1515
- License: [BSD-3-Clause](https://github.com/cta-observatory/lstosa/blob/main/LICENSE)
1616

1717
## Install
1818
We recommend using an isolated conda environment.
19-
- Install miniconda first.
19+
- Install mamba/miniconda first.
2020
- Clone the repository, create and activate the conda environment using the `environment.yml` file:
2121

2222
```bash
@@ -26,7 +26,7 @@ We recommend using an isolated conda environment.
2626
conda activate osa
2727
```
2828

29-
Then install `lstosa` as a **user** with: `pip install lstosa`, or as a **developer** with: `pip install -e .`.
29+
Then install `lstosa` as a **user** with: `pip install lstosa`, or as a **developer** with: `pip install -e .`. To install test, docs dependencies use `pip install -e .[test]`, `pip install -e .[doc]` or simply `pip install -e .[all]`
3030

3131
In case you want to install the lstchain development version instead of a fixed tag, you can run inside the `osa` environment:
3232

0 commit comments

Comments
 (0)