This project creates FAIR Digital Objects (FAIR-DOs) for multiple repositories, registers them with the Typed PID-Maker and indexes them in an Elasticsearch instance.
Currently, these repositories are supported:
See the created FAIR-DOs of the project.
If you want to explore these FAIR-DOs in a user-friendly manner, please visit the search interface. For more information, see the documentation.
Clone this project and use Poetry to install the dependencies.
git clone https://github.com/kit-data-manager/nmr_FAIR-DOs.git
cd nmr_FAIR-DOs
poetry installThis project works with Python > 3.8.
Get started by running the command line interface (CLI) with the nmr_FAIR-DOs command. You can use the --help flag to see the available options.
poetry run nmr_FAIR-DOs-cli --helpTo create FAIR-DOs for all NMR data in the repositories and log the output, run the following command:
poetry run nmr_FAIR-DOs-cli createallavailable 2>&1 | tee full.logMake sure you have pip > 21.2 (see pip --version), older versions have a bug causing
this problem. If the installed version is older, you can upgrade it with
pip install --upgrade pip and then try again to install the package.
You can find more information in the documentation.
If you want to cite this project in your scientific work, please use the citation file in the repository.
This is a Python project generated from the fair-python-cookiecutter template.
We kindly thank all authors and contributors.
This tool was created at Karlsruhe Institute of Technology (KIT) at the Scientific Computing Center (SCC) in the department Data Exploitation Methods (DEM).
This work is supported by the consortium NFDI-MatWerk, funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under the National Research Data Infrastructure – NFDI 38/1 – project number 460247524. TODO: relevant organizational acknowledgements (employers, funders)