-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some details around install commands.
- Loading branch information
1 parent
dd3dda7
commit 935f178
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# acr-harmonized-data-model | ||
LinkML Schema for ACR Harmonmized Data. | ||
|
||
# Tools Required | ||
* Python 3.12 (3.13 support [coming for linkml](https://github.com/linkml/linkml-runtime/pull/345)) | ||
* LinkML 1.8.6 | ||
* Pydantic 2.10.6 | ||
* [mkdocs](https://www.mkdocs.org/) required to generate the documentation website | ||
|
||
Tools to install: | ||
``` | ||
pip install linkml | ||
pip install mkdocs | ||
pip install mkdocs-mermaid2-plugin | ||
``` | ||
|
||
Users can probably get away with slightly older versions but be aware that later versions of LinkML do require pydantic >= 2.x.x | ||
|
||
# Creating the anvil project | ||
Here is the command to [generate default artifacts](https://linkml.io/linkml/generators/project-generator.html) if there is a need. | ||
|
||
``` | ||
gen-project -d anvil data-model/anvil.yaml | ||
``` | ||
|
||
# Creating the docs | ||
``` | ||
gen-doc -d docs data-model/anvil.yaml | ||
mkdocs build | ||
``` | ||
|
||
# Validating Test Data | ||
``` | ||
linkml-validate -s data-model/participant.yaml test-data/participant.csv -C Participant | ||
``` |