biolink-model 3.4.3__py3.10.egg

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
EGG-INFO/PKG-INFO ADDED
@@ -0,0 +1,163 @@
1
+ Metadata-Version: 2.1
2
+ Name: biolink-model
3
+ Version: 3.4.3
4
+ Summary: 'A high level datamodel of biological entities and associations'
5
+ Home-page: https://github.com/biolink/biolink-model
6
+ Author: ('Deepak Unni', 'Sierra Moxon')
7
+ Author-email: smoxon@lbl.gov
8
+ License: BSD
9
+ Keywords: NCATS NCATS-Translator Biolink-Model Biolink LinkML Datamodel
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Healthcare Industry
13
+ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
14
+ Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
15
+ Classifier: Programming Language :: Python :: 3 :: Only
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Requires-Python: >=3.9
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ License-File: AUTHORS
21
+
22
+ [![](https://img.shields.io/github/license/biolink/biolink-model)](https://img.shields.io/github/license/biolink/biolink-model)
23
+ [![Biolink Model](https://img.shields.io/github/v/release/biolink/biolink-model?style=flat-square)](https://img.shields.io/github/v/release/biolink/biolink-model?style=flat-square)
24
+ [![Python 3.7](https://upload.wikimedia.org/wikipedia/commons/f/fc/Blue_Python_3.7_Shield_Badge.svg)](https://www.python.org/downloads/release/python-370/)
25
+ [![Build Status](https://travis-ci.com/biolink/biolink-model.svg?branch=master)](https://travis-ci.com/biolink/biolink-model)
26
+ [![DOI](https://zenodo.org/badge/112995625.svg)](https://zenodo.org/badge/latestdoi/112995625)
27
+ [![Join the chat at https://gitter.im/biolink-model/community](https://badges.gitter.im/biolink-model/community.svg)](https://gitter.im/biolink-model/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
28
+ ![Regenerate Biolink Model Artifacts](https://github.com/biolink/biolink-model/workflows/Regenerate%20Biolink%20Model%20Artifacts/badge.svg)
29
+ ![Deploy Documentation](https://github.com/biolink/biolink-model/workflows/Deploy%20Documentation/badge.svg)
30
+
31
+ <img src="images/biolink-logo.png" width="20%">
32
+
33
+ # Biolink Model
34
+
35
+ Quickstart docs:
36
+
37
+ For a good overview of the biolink-model, [watch Chris Mungall's talk](https://www.youtube.com/watch?v=RE1hFm8lvJA&t=2s) at ICBO 2020.
38
+
39
+ - Browse the model: [https://biolink.github.io/biolink-model](https://biolink.github.io/biolink-model)
40
+ - [named thing](https://biolink.github.io/biolink-model/docs/NamedThing.html)
41
+ - [association](https://biolink.github.io/biolink-model/docs/Association.html)
42
+ - [predicate](https://biolink.github.io/biolink-model/docs/predicates.html)
43
+
44
+
45
+ Refer to the following resources for a quick introduction to the Biolink Model:
46
+ - [Introduction to the Biolink Datamodel](https://www.slideshare.net/cmungall/introduction-to-the-biolink-datamodel)
47
+ - [Biolink Model - A community driven data model for life sciences](https://bit.ly/biolink-model-workshop-biocuration-2020) (Biocuration 2020)
48
+ - Slides: https://bit.ly/biolink-model-workshop-biocuration-2020
49
+ - Video: https://www.youtube.com/watch?v=RE1hFm8lvJA
50
+
51
+ See also [Biolink Model Guidelines](guidelines/README.md) for help understanding, curating, and working with the model.
52
+
53
+
54
+ ## Introduction
55
+
56
+ The purpose of the Biolink Model is to provide a high-level datamodel of
57
+ biological entities (genes, diseases, phenotypes, pathways, individuals, substances, etc),
58
+ their properties, relationships, and enumerate ways in which they can be associated.
59
+
60
+ The representation is independent of storage technology or metamodel (Solr documents, neo4j/property graphs,
61
+ RDF/OWL, JSON, CSVs, etc). Different mappings to each of these are provided.
62
+
63
+ The specification of the Biolink Model is a [single YAML file](biolink-model.yaml) built using [linkml](https://github.com/linkml).
64
+ The basic elements of the YAML are:
65
+
66
+ - Class Definitions: definitions of upper level *classes* representing both 'named thing' and 'association'
67
+ - Slot Definitions: definitions of *slots* (aka properties) that can be used to relate members of these classes to other classes or data types. Slots collectively refer to predicates, node properties, and edge properties
68
+
69
+ The model itself is being used in the following projects:
70
+ - [NCATS Biomedical Data Translator](https://ncats.nih.gov/translator)
71
+ - [Monarch Initiative](https://monarchinitiative.org/)
72
+ - [KG-COVID-19](https://github.com/Knowledge-Graph-Hub/kg-covid-19/wiki)
73
+ - [KG Microbe](https://github.com/Knowledge-Graph-Hub/kg-microbe)
74
+ - [Illuminating the Druggable Genome]()
75
+
76
+
77
+ ## Organization
78
+
79
+ The main source of truth is [biolink-model.yaml](biolink-model.yaml). This is a YAML file that is intended to
80
+ be relatively simple to view and edit in its native form.
81
+
82
+ The yaml definition is currently used to derive:
83
+
84
+ - [JSON Schema](json-schema)
85
+ - [Python dataclasses](biolink/model.py)
86
+ - [Java code gen](java)
87
+ - [ProtoBuf definitions](biolink-model.proto)
88
+ - [GraphQL](biolink-model.graphql)
89
+ - [RDF](biolink-model.ttl)
90
+ - [OWL](biolink-model.owl.ttl)
91
+ - [RDF Shape Expressions](biolink-model.shex)
92
+ - [JSON-LD context](context.jsonld)
93
+ - [Graphviz](graphviz)
94
+ - [GOlr YAML schemas](golr-views)
95
+ - these can be compiled down to Solr XML schemas
96
+ - these are also intermediate targets used within the BBOP/AmiGO framework
97
+ - [Markdown documentation](docs)
98
+
99
+
100
+
101
+
102
+ ## Make and build instructions
103
+
104
+ Prerequisites: Python 3.7+ and pipenv
105
+
106
+ To install pipenv,
107
+
108
+ ```sh
109
+ pip3 install pipenv
110
+ ```
111
+
112
+ To install the project,
113
+ ```sh
114
+ make install
115
+ ```
116
+
117
+ To regenerate artifacts from the Biolink Model YAML,
118
+
119
+ ```sh
120
+ make
121
+ ```
122
+
123
+
124
+ **Note:** the Makefile requires the following dependencies to be installed:
125
+
126
+ ### jsonschema
127
+
128
+ [jsonschema](https://json-schema.org/)
129
+
130
+ Generally install using
131
+
132
+ ```sh
133
+ pip3 install jsonschema
134
+ ```
135
+
136
+ ### jsonschema2pojo
137
+
138
+ [jsonschema2pojo](https://github.com/joelittlejohn/jsonschema2pojo)
139
+
140
+ If you are on a Mac, it can be installed using `brew`:
141
+ ```sh
142
+ brew install jsonschema2pojo
143
+ ```
144
+ For other OS environments, download the latest release then extract it into your execution path. eg
145
+ ```sh
146
+ wget https://github.com/joelittlejohn/jsonschema2pojo/releases/download/jsonschema2pojo-1.0.2/jsonschema2pojo-1.0.2.tar.gz
147
+ tar -xvzf jsonschema2pojo-1.0.2.tar.gz
148
+ export PATH=$PATH:`pwd`/jsonschema2pojo-1.0.2/bin
149
+ ```
150
+
151
+ ### GraphViz
152
+
153
+ See [GraphViz site](https://graphviz.org/) for installation in your operating system.
154
+
155
+
156
+
157
+ ## How do I use Biolink Model YAML programmatically?
158
+
159
+ For operations such as CURIE lookup, finding class by synonyms, get parents, get ancestors, etc. please make use of [biolink-model-toolkit](https://github.com/biolink/biolink-model-toolkit/). It provides convenience methods for traversing Biolink Model.
160
+
161
+ ## Citing Biolink Model
162
+ Unni DR, Moxon SAT, Bada M, Brush M, Bruskiewich R, Caufield JH, Clemons PA, Dancik V, Dumontier M, Fecho K, Glusman G, Hadlock JJ, Harris NL, Joshi A, Putman T, Qin G, Ramsey SA, Shefchek KA, Solbrig H, Soman K, Thessen AE, Haendel MA, Bizon C, Mungall CJ, The Biomedical Data Translator Consortium (2022).
163
+ Biolink Model: A universal schema for knowledge graphs in clinical, biomedical, and translational science. Clin Transl Sci. Wiley; 2022 Jun 6; https://onlinelibrary.wiley.com/doi/10.1111/cts.13302
EGG-INFO/SOURCES.txt ADDED
@@ -0,0 +1,16 @@
1
+ AUTHORS
2
+ LICENSE
3
+ README.md
4
+ pyproject.toml
5
+ setup.cfg
6
+ setup.py
7
+ biolink/__init__.py
8
+ biolink/model.py
9
+ biolink/pydanticmodel.py
10
+ biolink_model.egg-info/PKG-INFO
11
+ biolink_model.egg-info/SOURCES.txt
12
+ biolink_model.egg-info/dependency_links.txt
13
+ biolink_model.egg-info/requires.txt
14
+ biolink_model.egg-info/top_level.txt
15
+ tests/test_biolink_model.py
16
+ tests/test_pythongen.py
@@ -0,0 +1 @@
1
+
EGG-INFO/requires.txt ADDED
@@ -0,0 +1,3 @@
1
+ linkml
2
+ curies
3
+ prefixmaps
EGG-INFO/top_level.txt ADDED
@@ -0,0 +1 @@
1
+ biolink
EGG-INFO/zip-safe ADDED
@@ -0,0 +1 @@
1
+
biolink/__init__.py ADDED
@@ -0,0 +1,13 @@
1
+ # Biolink model file locations
2
+ import os
3
+
4
+ basedir = os.path.abspath(os.path.join(__file__, '..', '..'))
5
+ BIOLINK_MODEL_YAML = os.path.join(basedir, 'biolink-model.yaml')
6
+ BIOLINK_MODEL_JSONLD = os.path.join(basedir, 'context.jsonld')
7
+ BIOLINK_MODEL_SHEX = os.path.join(basedir, 'shex', 'biolink-model.shex')
8
+ BIOLINK_MODEL_RDF = os.path.join(basedir, 'rdf', 'biolink-model.ttl')
9
+ BIOLINK_MODEL_OWL = os.path.join(basedir, 'ontology', 'biolink-model.owl')
10
+ BIOLINK_MODEL_JSON = os.path.join(basedir, 'biolink-model.json')
11
+ BIOLINK_MODEL_JSON_SCHEMA = os.path.join(basedir, 'json-schema', 'biolink-model.json')
12
+ BIOLINK_MODEL_JAVA = os.path.join(basedir, 'java')
13
+ BIOLINK_MODEL_PYTHON = os.path.join(basedir, 'biolink', 'model.py')