dragonfly-schema 2.1.1

Dragonfly Data-Model Objects

dragonfly-schema

Dragonfly Data-Model that generates documentation and OpenAPI specifications for the DFJSON file schema.

Installation

pip install dragonfly-schema

QuickStart

import dragonfly_schema

API Documentation

Model Schema

Energy Simulation Parameter Schema

Local Development

1. Clone this repo locally

git clone [e-mail]:ladybug-tools/dragonfly-schema

# or

git clone https://github.com/ladybug-tools/dragonfly-schema

2. Install dependencies:

cd dragonfly-schema
pip install -r dev-requirements.txt
pip install -r requirements.txt

3. Run Tests:

python -m pytest tests/

4. Generate Documentation:

python ./docs.py

5. Generate Sample Files:

python ./scripts/export_samples.py