|
1 | 1 | ================================================ |
2 | | -nectarchain |pypi| |conda| |ci| |doc| |codecov| |
| 2 | +nectarchain |pypi| |conda| |CI| |docs| |codecov| |
3 | 3 | ================================================ |
4 | 4 |
|
5 | | -.. |ci| image:: https://github.com/cta-observatory/nectarchain/actions/workflows/ci.yml/badge.svg?branch=main |
6 | | - :target: https://github.com/cta-observatory/nectarchain/actions/workflows/ci.yml?query=workflow%3ACI+branch%3Amain |
7 | | - :alt: Test Status |
8 | | -.. |pypi| image:: https://badge.fury.io/py/nectarchain.svg |
9 | | - :target: https://pypi.org/project/nectarchain |
10 | | -.. |conda| image:: https://anaconda.org/conda-forge/nectarchain/badges/version.svg |
11 | | - :target: https://anaconda.org/conda-forge/nectarchain |
12 | | -.. |codecov| image:: https://codecov.io/github/cta-observatory/nectarchain/graph/badge.svg?token=TDhZlJtbMv |
13 | | - :target: https://codecov.io/github/cta-observatory/nectarchain |
14 | | -.. |doc| image:: https://readthedocs.org/projects/nectarchain/badge/?version=latest |
15 | | - :target: https://nectarchain.readthedocs.io/en/latest/?badge=latest |
16 | | - :alt: Documentation Status |
17 | 5 |
|
18 | | -Repository for the high level analysis of the NectarCAM data, a camera to equip the |
19 | | -medium-sized telescopes of `CTAO <https://www.ctao.org/>`_ in its Northern site. |
20 | | -The analysis is heavily based on `ctapipe <https://github.com/cta-observatory/ctapipe>`_, |
21 | | -adding custom code for NectarCAM calibration. |
| 6 | +Repository for the high level analysis of the NectarCAM data, a camera |
| 7 | +to equip the medium-sized telescopes of `CTAO <https://www.ctao.org/>`__ |
| 8 | +in its Northern site. The analysis is heavily based on |
| 9 | +`ctapipe <https://github.com/cta-observatory/ctapipe>`__, adding custom |
| 10 | +code for NectarCAM calibration. |
22 | 11 |
|
23 | 12 | ``nectarchain`` is currently pinned to ``ctapipe`` version 0.19. |
24 | 13 |
|
25 | | -This code is under rapid development. It is not recommended for production use unless you are an expert or developer! |
| 14 | +This code is under rapid development. It is not recommended for |
| 15 | +production use unless you are an expert or developer! |
26 | 16 |
|
27 | | -* Code: https://github.com/cta-observatory/nectarchain |
28 | | -* Docs: https://nectarchain.readthedocs.io/ |
| 17 | +- Code: https://github.com/cta-observatory/nectarchain |
| 18 | +- Docs: https://nectarchain.readthedocs.io/ |
29 | 19 |
|
30 | 20 | Installation for Users |
31 | 21 | ====================== |
32 | 22 |
|
33 | | -``nectarchain`` and its dependencies may be installed using the *Anaconda* or |
34 | | -*Miniconda* package system. We recommend creating a conda virtual environment |
35 | | -first, to isolate the installed version and dependencies from your main |
36 | | -environment (this is optional). |
| 23 | +``nectarchain`` and its dependencies may be installed using the |
| 24 | +*Anaconda* or *Miniconda* package system. We recommend creating a conda |
| 25 | +virtual environment first, to isolate the installed version and |
| 26 | +dependencies from your main environment (this is optional). |
37 | 27 |
|
38 | | -The latest version of ``nectarchain`` can be installed via:: |
| 28 | +The latest version of ``nectarchain`` can be installed via: |
39 | 29 |
|
40 | | - mamba install -c conda-forge nectarchain |
| 30 | +:: |
41 | 31 |
|
42 | | -or via:: |
| 32 | + mamba install -c conda-forge nectarchain |
43 | 33 |
|
44 | | - pip install nectarchain |
| 34 | +or via: |
45 | 35 |
|
46 | | -**Note**: to install a specific version of ``nectarchain``, take look at the documentation `here <https://nectarchain.readthedocs.io/en/latest/user-guide/index.html>`_. |
| 36 | +:: |
47 | 37 |
|
48 | | -**Note**: ``mamba`` is a C++ reimplementation of conda and can be found `here <https://github.com/mamba-org/mamba>`_. |
| 38 | + pip install nectarchain |
49 | 39 |
|
50 | | -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). |
| 40 | +**Note**: to install a specific version of ``nectarchain``, take look at |
| 41 | +the documentation |
| 42 | +`here <https://nectarchain.readthedocs.io/en/latest/user-guide/index.html>`__. |
51 | 43 |
|
52 | | -Developers should follow the development install instructions found in the |
53 | | -`documentation <https://nectarchain.readthedocs.io/en/latest/developer-guide/index.html>`_. |
| 44 | +**Note**: ``mamba`` is a C++ reimplementation of conda and can be found |
| 45 | +`here <https://github.com/mamba-org/mamba>`__. |
54 | 46 |
|
| 47 | +Note this is *pre-alpha* software and is not yet stable enough for |
| 48 | +end-users (expect large API changes until the first stable 1.0 release). |
| 49 | + |
| 50 | +Developers should follow the development install instructions found in |
| 51 | +the |
| 52 | +`documentation <https://nectarchain.readthedocs.io/en/latest/developer-guide/index.html>`__. |
55 | 53 |
|
56 | 54 | Contributing |
57 | 55 | ============ |
58 | 56 |
|
59 | 57 | All contribution are welcome. |
60 | 58 |
|
61 | | -Guidelines are the same as `ctapipe's ones <https://ctapipe.readthedocs.io/en/latest/developer-guide/getting-started.html>`_. |
62 | | -See `here <https://ctapipe.readthedocs.io/en/latest/developer-guide/pullrequests.html#pullrequests>`_ how to make a pull request to contribute. |
63 | | - |
| 59 | +Guidelines are the same as `ctapipe's |
| 60 | +ones <https://ctapipe.readthedocs.io/en/latest/developer-guide/getting-started.html>`__. |
| 61 | +See |
| 62 | +`here <https://ctapipe.readthedocs.io/en/latest/developer-guide/pullrequests.html#pullrequests>`__ |
| 63 | +how to make a pull request to contribute. |
64 | 64 |
|
65 | 65 | Report issue / Ask a question |
66 | 66 | ============================= |
67 | 67 |
|
68 | | -Please use `GitHub Issues <https://github.com/cta-observatory/nectarchain/issues>`_ to report issues or `GitHub Discussions <https://github.com/cta-observatory/nectarchain/discussions>`_ for questions and discussions. |
| 68 | +Please use `GitHub |
| 69 | +Issues <https://github.com/cta-observatory/nectarchain/issues>`__ to |
| 70 | +report issues or `GitHub |
| 71 | +Discussions <https://github.com/cta-observatory/nectarchain/discussions>`__ |
| 72 | +for questions and discussions. |
| 73 | + |
| 74 | +.. |pypi| image:: https://badge.fury.io/py/nectarchain.svg |
| 75 | + :target: https://pypi.org/project/nectarchain |
| 76 | +.. |conda| image:: https://anaconda.org/conda-forge/nectarchain/badges/version.svg |
| 77 | + :target: https://anaconda.org/conda-forge/nectarchain |
| 78 | +.. |CI| image:: https://github.com/cta-observatory/nectarchain/actions/workflows/ci.yml/badge.svg?branch=main |
| 79 | + :target: https://github.com/cta-observatory/nectarchain/actions/workflows/ci.yml?query=workflow%3ACI+branch%3Amain |
| 80 | +.. |docs| image:: https://readthedocs.org/projects/nectarchain/badge/?version=latest |
| 81 | + :target: https://nectarchain.readthedocs.io/en/latest/?badge=latest |
| 82 | +.. |codecov| image:: https://codecov.io/github/cta-observatory/nectarchain/graph/badge.svg?token=TDhZlJtbMv |
| 83 | + :target: https://codecov.io/github/cta-observatory/nectarchain |
0 commit comments