Skip to content

Commit a8b0822

Browse files
committed
Document Quickstart
1 parent a984b2e commit a8b0822

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/sphinx/source/api/Quickstart.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Quick Start Guide to Modelspec
2+
3+
This is a quick guide to the various parts of the modelspec module and examples.
4+
5+
## Installation of Python API
6+
7+
Use **pip** to install the latest version of modelspec (plus dependencies) from [PyPI](https://pypi.org/project/modelspec):
8+
```
9+
pip install modelspec
10+
```
11+
12+
More details, and importantly, how to set up a [virtual environment](https://virtualenv.pypa.io/en/latest/) for the package, can be found [here](Installation).
13+
14+
## Examples of Modelspec
15+
16+
### Simple example
17+
18+
A basic example which illustrates how to create the specification for a document(model) and create serialized instances can be found [here](examples/README)
19+
20+
### Serialization formats
21+
22+
Python scripts can be used to generate the specification of a type of model(e.g. [this](https://github.com/ModECI/modelspec/blob/main/examples/document.py)), but the models are saved in standardized format in either text based [JSON](https://github.com/ModECI/modelspec/blob/main/examples/document.json) or [YAML](https://github.com/ModECI/modelspec/blob/main/examples/document.yaml) formats or in binary [BSON](https://github.com/ModECI/modelspec/blob/main/examples/document.bson) format.
23+
24+
### Currently supported environments
25+
26+
#### MDF
27+
28+
Mdf uses modelspec to create the structure of its models and convert the models into serialize formats such as json, yaml, and bson.
29+
30+
#### NeuroML
31+
32+
NeuroMLite uses modelspec to create the structure of its models and convert the models into serialize formats such as json, yaml, and bson.

0 commit comments

Comments
 (0)