Enhancement of URBANopt GeoJSON that can be consumed by DiTTo reader
Project description
urbanopt-ditto-reader
Enhancement of URBANopt™ GeoJSON that can be consumed by DiTTo reader More detailed documentation is available on the URBANopt documentation page
Installation Pre-requisites
- Python >=3.7
Installation
pip install urbanopt-ditto-reader
Running the converter
Use the included Command Line Interface:
ditto_reader_cli -h
For help text in the terminal:
ditto_reader_cli run-opendss -h
Example command to run the ditto-reader:
ditto_reader_cli run-opendss -s <ScenarioFile> -f <FeatureFile>
Or build and use a config file (not necessary if using flags like the above example):
ditto_reader_cli run-opendss -c example/config.json
If you are using your own config.json file, use the following fields:
- "urbanopt_scenario_file": Required, Path to scenario csv file
- "urbanopt_geojson_file": Required, Path to feature json file
- "equipment_file": Optional, Path to custom equipment file
- "opendss_folder": Required, Path to dir created by this command, holding openDSS output
- "use_reopt": Required, Boolean (True/False) to analyze reopt data, if it has been provided
- "number_of_timepoints": Required, Integer number of hours to simulate. 8760 is a complete year
Developer installation
Clone the repository:
git clone https://github.com/urbanopt/urbanopt-ditto-reader.git
Change directories into the repository:
cd urbanopt-ditto-reader
Install the respository:
pip install -e .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for urbanopt-ditto-reader-0.3.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4720fbdd8a91cdd4bec6d65603c0f70e33de89768d6ed56c8a9a772dfbe38024 |
|
MD5 | d1daebb1560e0d1e92b8181895f0204f |
|
BLAKE2b-256 | 104205b18c006f9b2688efadb65046a4b0ccfeb8e8819e2df0ef3ada51f1a8ff |
Close
Hashes for urbanopt_ditto_reader-0.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30591d30e7ed82d8c0aec537a9c4251e50bf85ac44c0e715a6d230282ecd6d97 |
|
MD5 | 4e90ad2c012e7d9c1614cfe3e70c3586 |
|
BLAKE2b-256 | e4c3c9245ed8b2b3e2b77886eb1e213f109fefb753469e45545f196bd318cf14 |