There is a newer version of the record available.

Published January 17, 2023 | Version v1.0a0
Software Open

eossr

  • 1. Univ. Savoie Mont Blanc, CNRS, LAPP
  • 2. GSI
  • 3. ECAP, FAU (Nuremberg, Germany)

Description

The ESCAPE OSSR library

The eOSSR Python library gathers all the developments made for the OSSR. In particular, it includes:- an API to programmatically access the OSSR, retrieve records and publish content- functions to map and crosswalk metadata between the CodeMeta schema adopted for the OSSR and Zenodo internal schema- functions to help developers automatically contribute to the OSSR, in particular using their continuous integration (see also code snippets)

Code: https://gitlab.in2p3.fr/escape2020/wp3/eossrDocumentation: https://escape2020.pages.in2p3.fr/wp3/eossr/

Former stable versions
  • v0.6:
  • v0.5:
  • v0.4:
  • v0.3.3:
  • v0.2 :
Install

Commands to be run in your terminal.

For users
cd eossrpip install .

You can also run it with docker:

docker run -it gitlab-registry.in2p3.fr/escape2020/wp3/eossr:latest

Visit our registry to see the available docker containers.

Note that latest tag always point to the latest stable released container.

For developers
git clone https://gitlab.in2p3.fr/escape2020/wp3/eossr.gitcd eossrpip install -e .
Running tests

To run tests locally, run:

pip install -e ".[tests]"pytest eossr

Some tests will be skiped if SANDBOX_ZENODO_TOKEN is not defined in your environment variables.If you want to run these tests, you will need to create a sandbox zenodo token and add it to your env:

export SANDBOX_ZENODO_TOKEN="your_sandbox_token"
Online CodeMeta validator for the OSSR

The eOSSR powers an online validator for your CodeMeta metadata and to convert it to Zenodo metadata.

Just follow this link (running on mybinder)

License

See LICENSE

Cite

To cite this library, please cite our ADASS proceedings:

@misc{https://doi.org/10.48550/arxiv.2212.00499,  doi = {10.48550/ARXIV.2212.00499},  url = {https://arxiv.org/abs/2212.00499},  author = {Vuillaume, Thomas and Garcia, Enrique and Tacke, Christian and Gal, Tamas},  keywords = {Instrumentation and Methods for Astrophysics (astro-ph.IM), FOS: Physical sciences, FOS: Physical sciences},  title = {The eOSSR library},  publisher = {arXiv},  year = {2022},  copyright = {arXiv.org perpetual, non-exclusive license}}

If you used the library in a workflow, please cite the version used as well, using the cite section in the Zenodo page (right column, below the Versions section).

Notes

Release Notes: eOSSR v1.0-alpha This release refactors the metadata validators, having one for Zenodo and one for CodeMeta with ESCAPE requirements. It also fixes some bug in the conversion from Zenodo to CodeMeta. ESCAPE becomes optional in the publication process. Changelog since release v0.6.1 of eossr: * update codemeta with release notes (@vuillaume) * Adding reference publication in readme and codemeta (@vuillaume) * remove build dir in snippet and in our CI (@vuillaume) * download record (@vuillaume) * Zenodo metadata validator (@vuillaume) * add load from record ID in online validator (@vuillaume) * Refactor record deposit (@vuillaume) * check codemeta context points to codemeta-2.0 before converting (@vuillaume) * single implementation to write zenodo metadata (@vuillaume) * Upload repository escape option (@vuillaume) * Fix codemeta to zenodo license converter (@garcia) * add converter to validation notebook (@vuillaume) * Simplify CodeMeta validator and propose online validator based on binder (@vuillaume) * Fix mybinder environment (@vuillaume) * pointing to mybinder branch (@vuillaume) * Update .gitlab-ci-update-codemeta.yml (@vuillaume) * Add --sandbox in snippet (@vuillaume) * Fix warning publication date in zenodo validate (@vuillaume)

Files

eossr.zip

Files (1.1 MB)

Name Size Download all
md5:85479d0da91b6cfd219e64e4986e2086
1.1 MB Preview Download

Additional details

Related works

Is derived from
Software: https://gitlab.in2p3.fr/escape2020/wp3/eossr (URL)
Is documented by
Software documentation: https://gitlab.in2p3.fr/escape2020/wp3/eossr/-/blob/master/README.md (URL)

Funding

European Commission
ESCAPE - European Science Cluster of Astronomy & Particle physics ESFRI research infrastructures 824064