The ds-km-precompiler’s documentation!¶
Welcome to the DS-KM Precompiler‘s documentation. Continue by choosing the desired topic from the list of contents. You can also visit the repository ds-km-precompiler@GitHub or learn more about Data Stewardship Portal projects.
Contents¶
Introduction¶
DS-KM Precompiler is tool related to project Data Stewardship Portal developed by ELIXIR-NL and ELIXIR-CZ within the ELIXIR platform. Main goal of this tool is to create reference precompiler of DS Knowledge Model data (applying rules, merging multiple files into one depending on requests and configuration). First big user of precompiler is DS Portal itself.
This project just started and is using first legacy precompiler at the moment. But that will hopefully change soon.
Installation¶
This application can be installed via standard setuptools, for
more information read Python docs - Installing Python Module.
Required Python version 3.6+ (tested on 3.5 and 3.6)
setup.py¶
Download the repository from GitHub and run:
$ python3 setup.py install
(You can use Python virtual environment instead of system-wide.)
Check installation¶
After the successful installation you should be able to run:
$ dskm_precompiler --version
Usage¶
Simple usage example:
$ dskm_precompiler [PATH_TO_DSKM_DATAMODEL] [CMD]
$ dskm_precompiler ../ds-km/datamodel list-ns
core:
elixir-nl: core
lifesciences: core
$ dskm_precompiler ../ds-km/datamodel build > output.json
For more use:
$ dskm_precompiler --help