Skip to content

ladybug-tools/uwg-schema

Repository files navigation

Build Status Coverage Status

Python 3.7

uwg-schema

🌇 📜 Input schema for the Urban Weather Generator (UWG).

Installation

pip install uwg-schema

QuickStart

import uwg_schema

API Documentation

Model Schema

Simulation Parameter Schema

Local Development

  1. Clone this repo locally
git clone git@github.com:ladybug-tools/uwg-schema

# or

git clone https://github.com/ladybug-tools/uwg-schema
  1. Install dependencies:
cd uwg-schema
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
python ./docs.py
  1. Generate Sample Files:
python ./scripts/export_samples.py