diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..b30267d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,15 @@ +/* +* Copyright 2020 AvaFrame +* +* Licensed under the EUPL, Version 1.2 or later versions of the EUPL (the "Licence"); +* You may not use this work except in compliance with the Licence. +* You may obtain a copy of the Licence at: +* +* https://joinup.ec.europa.eu/collection/eupl +* +* Unless required by applicable law or agreed to inwriting, software distributed under the Licence +is distributed on an "AS IS" basis, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the Licence for the specific language governing permissions and +limitations under the Licence. +*/ diff --git a/README.md b/README.md deleted file mode 100644 index 822e669..0000000 --- a/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# AvaFrame - -This is the main AvaFrame repository - -## Directory structure: - -``` --avaframe: main python scripts etc - |-data: data needed for calibration/tests/etc - |-tests: pytest scripts - --benchmarks: our references - --docs: md/rst for ReadTheDoc documentation -``` - - -## Documentation - -For the documentation install sphinx with - -``` -pip install sphinx -``` -(or equivalent conda command) - -We use the ReadTheDocs theme, which you need to install with - -``` -pip install sphinx-rtd-theme -``` - -Goto docs directory and e.g. - -``` -make html -``` - -to generate html documentation within the _build directory diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..256a8db --- /dev/null +++ b/README.rst @@ -0,0 +1,70 @@ + +This is the AvaFrame repository +------------------------------- + +Installation, documentation +--------------------------- + +The documentation is hosted on ReadTheDocs: http://docs.avaframe.org + +For local documentation install sphinx with:: + + pip install sphinx + +(or equivalent conda command) + +We use the ReadTheDocs theme, which you need to install with:: + + pip install sphinx-rtd-theme + +Goto docs directory and e.g.:: + + make html + +to generate html documentation within the _build directory. + + + + +Directory structure: +-------------------- + +:: + + -avaframe: main python scripts etc + |-data: data needed for calibration/tests/etc + |-tests: pytest scripts + + -benchmarks: our references + + -docs: rst for ReadTheDoc documentation + + + + + +About +----- + +.. :Citation: +.. .. image:: https://zenodo.org/badge/43965645.svg +.. :target: https://zenodo.org/badge/latestdoi/43965645 +.. :alt: Zenodo + +:Tests: + .. image:: https://readthedocs.org/projects/avaframe/badge/?version=latest + :target: http://docs.avaframe.org/en/latest/ + :alt: Documentation status + +.. .. image:: https://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat + +:License: + .. image:: https://img.shields.io/badge/license%20EUPL-green.svg?style=flat + :target: https://git.avaframe.org/AvaFrame/AvaFrame/src/branch/master/LICENSE.txt + :alt: European Union Public License (EUPL) + +.. :Authors: + +.. See the `version history`_ for a list of all contributors. + +.. .. _version history: http://docs.oggm.org/en/latest/whats-new.html