diff --git a/README.md b/README.md index 2dd4103fdc81cb1d50a74964af9bbd8d62f67609..e55268c2b1228f844533ed734f7ff83a1da3213b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# eossr + + +## The ESCAPE OSSR library + +* Code: [https://gitlab.in2p3.fr/escape2020/wp3/eossr](https://gitlab.in2p3.fr/escape2020/wp3/eossr) +* Documentation: [https://escape2020.pages.in2p3.fr/wp3/eossr/](https://escape2020.pages.in2p3.fr/wp3/eossr/) + + []( https://gitlab.in2p3.fr/escape2020/wp3/eossr/-/commits/master) @@ -9,11 +16,6 @@ https://gitlab.in2p3.fr/escape2020/wp3/eossr/-/commits/master) [](https://mybinder.org/v2/git/https%3A%2F%2Fgitlab.in2p3.fr%2Fescape2020%2Fwp3%2Feossr/HEAD) -ESCAPE OSSR library - -* Code: https://gitlab.in2p3.fr/escape2020/wp3/eossr -* Documentation: https://escape2020.pages.in2p3.fr/wp3/eossr/ - ## Versions @@ -40,3 +42,7 @@ docker run -it gitlab-registry.in2p3.fr/escape2020/wp3/eossr:latest git clone https://gitlab.in2p3.fr/escape2020/wp3/eossr.git pip install eossr ``` + +## Cite + +To cite this library, use the cite module in [the Zenodo page](https://zenodo.org/record/5524913#.YWBq79kzZB0). diff --git a/docs/images/eossr_logo.png b/docs/images/eossr_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..8c3eebf29d88d84c43421315914df2b47082bba9 Binary files /dev/null and b/docs/images/eossr_logo.png differ diff --git a/docs/index.rst b/docs/index.rst index 93d12794edb29edcc899ebf5a5b915b62f01db73..55b127cd01cb38548bef4ccde1c79b64cae5df19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to eossr's documentation! +Welcome to eOSSR's documentation! ================================= .. toctree::