Merge pull request #62 from HealthyPear/update-README

Update documentation + general maintenance

.gitignore

@@ -27,10 +27,8 @@ MANIFEST
 docs/api
 docs/_build
 
-# Benchmarks
-docs/contribute/benchmarks/TRAINING/plots/*
-docs/contribute/benchmarks/DL2/plots/*
-docs/contribute/benchmarks/DL3/plots/*
+# Benchmark plots
+plots/
 
 # Eclipse editor project files
 .project

.mailmap

@@ -2,8 +2,9 @@ Michele Peresano <michele.peresano@cea.fr> Michele Peresano <michele.peresano@.c
 Michele Peresano <michele.peresano@cea.fr> Michele Peresano <peresano.michele@gmail.com>
 Julien Lefaucheur <julien.lefaucheur@obspm.fr>
 Thierry Stolarczyk <thierry.stolarczyk@cea.fr>
-Gaia Verna <gverna94@gmail.com> gaia-verna <51763341+gaia-verna@users.noreply.github.com>
-Gaia Verna <gverna94@gmail.com> gaia-verna <gverna94@gmail.com>
+Gaia Verna <verna@cppm.in2p3.fr> gaia-verna <51763341+gaia-verna@users.noreply.github.com>
+Gaia Verna <verna@cppm.in2p3.fr> gaia-verna <gverna94@gmail.com>
+Gaia Verna <verna@cppm.in2p3.fr> gaia-verna <verna@cppm.in2p3.fr>
 David Landriu <landriu@sapcta.extra.cea.fr>
 Karl Kosack <karl.kosack@cea.fr> Karl Kosack <kosack@users.noreply.github.com>
 Thomas Vuillaume <thomas.vuillaume@gmail.com> vuillaut <thomas.vuillaume@gmail.com>

.prospector.yaml

@@ -0,0 +1,7 @@
+pep257:
+  disable:
+    - D104
+    - D201
+    - D202
+    - D211
+    - D213

.readthedocs.yml

@@ -0,0 +1,17 @@
+version: 2
+
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+    - method: setuptools
+      path: .
+  system_packages: true
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

.zenodo.json

@@ -0,0 +1,61 @@
+{
+  "description": "A ctapipe-based pipeline prototype for the Cherenkov Telescope Array (CTA).",
+  "license":  {
+    "id": "CECILL-B"
+  },
+  "keywords": [
+    "gamma-ray astronomy",
+    "Imaging Atmospheric Cherenkov Telescope",
+    "IACT",
+    "CTA",
+    "pipeline",
+    "simulations",
+    "grid",
+  ],
+  "upload_type": "software",
+  "creators": [
+    {
+      "orcid": "0000-0002-7537-7334",
+      "affiliation": "AIM, CEA, CNRS, Universite Paris-Saclay, Universite Paris Diderot, Sorbonne Paris Cite, F-91191 Gif-sur-Yvette, France",
+      "name": "Peresano, Michele"
+    }
+  ],
+  "access_right": "open",
+  "contributors": [
+      {
+        "type": "Other",
+        "name": "Lefaucheur, Julien"
+      },
+      {
+        "affiliation": "AIM, CEA, CNRS, Universite Paris-Saclay, Universite Paris Diderot, Sorbonne Paris Cite, F-91191 Gif-sur-Yvette, France",
+        "type": "Other",
+        "name": "Stolarczyk, Thierry"
+      },
+      {
+        "affiliation": "AIM, CEA, CNRS, Universite Paris-Saclay, Universite Paris Diderot, Sorbonne Paris Cite, F-91191 Gif-sur-Yvette, France",
+        "type": "Other",
+        "name": "Kosack, Karl"
+      },
+      {
+        "affiliation": "Aix Marseille Univ, CNRS/IN2P3, CPPM, Marseille, France",
+        "type": "Other",
+        "name": "Verna, Gaia"
+      },
+      {
+        "affiliation": "Universit\u00e0 di Udine & INFN Trieste",
+        "type": "Other",
+        "name": "Donini, Alice"
+      },
+      {
+        "orcid": "0000-0002-5686-2078",
+        "affiliation": "Laboratoire d'Annecy de Physique des Particules, Univ. Grenoble Alpes, Univ. Savoie Mont Blanc, CNRS, LAPP, 74000 Annecy, France",
+        "type": "Other",
+        "name": "Vuillaume, Thomas"
+      },
+      {
+        "affiliation": "AIM, CEA, CNRS, Universite Paris-Saclay, Universite Paris Diderot, Sorbonne Paris Cite, F-91191 Gif-sur-Yvette, France",
+        "type": "Other",
+        "name": "Landriu, David"
+      }
+    ]
+}

README.rst

@@ -0,0 +1,44 @@
+==================================================
+protopipe |CI| |codacy| |coverage| |documentation|
+==================================================
+
+.. |CI| image:: https://github.com/cta-observatory/protopipe/workflows/CI/badge.svg?branch=master
+  :target: https://github.com/cta-observatory/protopipe/actions?query=workflow%3ACI
+.. |codacy|  image:: https://app.codacy.com/project/badge/Grade/cb95f2eee92946f2a68acc7b103f843c
+  :target: https://www.codacy.com/gh/cta-observatory/protopipe?utm_source=github.com&utm_medium=referral&utm_content=cta-observatory/protopipe&utm_campaign=Badge_Grade
+.. |coverage| image:: https://codecov.io/gh/cta-observatory/protopipe/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/cta-observatory/protopipe
+.. |documentation| image:: https://readthedocs.org/projects/protopipe/badge/?version=latest
+  :target: https://protopipe.readthedocs.io/en/latest/?badge=latest
+.. |doilatest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4303996.svg
+  :target: https://doi.org/10.5281/zenodo.4303996
+
+A pipeline prototype for the `Cherenkov Telescope Array (CTA) <www.cta-observatory.org>`_.
+
+- based on the `ctapipe <https://cta-observatory.github.io/ctapipe/>`_ and
+  `pyirf <https://cta-observatory.github.io/pyirf/>`__ libraries plus original code
+- successfully tested code migrated and imported from each new release
+- allows for full-scale analyses on the `DIRAC <http://diracgrid.org/>`__ computing grid
+
+Resources
+---------
+
+- Source code: `GitHub repository <https://github.com/cta-observatory/protopipe>`__
+- Documentation (master branch): `GitHub Pages <https://cta-observatory.github.io/protopipe>`__
+- Current performance: `RedMine <https://forge.in2p3.fr/projects/benchmarks-reference-analysis/wiki/Protopipe_performance_data>`__
+
+- Slack channels:
+  - `#protopipe <https://cta-aswg.slack.com/archives/CPTN4U7U7>`__
+  - `#protopipe_github <https://cta-aswg.slack.com/archives/CPUSPPHST>`__
+  - `#protopipe-grid <https://cta-aswg.slack.com/archives/C01FWH8E0TT>`__
+
+Citing this software
+--------------------
+
+If you use a released version of this software for a publication,
+please cite it by using the corresponding DOI.
+
+Please, check the development version of this file for up-to-date links.
+
+- v0.3.0 : |doilatest|
+- v0.4.0 : TBD

docs/AUTHORS.rst

@@ -5,11 +5,11 @@ Authors
 
 Current contributors are listed
 
-- `here <https://github.com/cta-observatory/pyirf/graphs/contributors>`__ for ``protopipe``
+- `here <https://github.com/cta-observatory/protopipe/graphs/contributors>`__ for ``protopipe``
 - Michele Peresano for the ``GRID interface``
 
 
-A full list can be obtained also by issuing the following command from each
+A full list can be obtained also by issuing the following command from any
 source code folder,
 
 .. code-block:: bash