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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14c7d87774adc7df39f53f4da6e6394398e8a7d1974c1da314c3bb4c50b92137 |
|
MD5 | 3484150441b0d22b9a51310a376f344c |
|
BLAKE2b-256 | 491be8baa454e44490a7bdc728bef9782e83aaaa163696ed49c0d242bc9f790d |
Close
Hashes for urbanopt_ditto_reader-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cee7c5613e4c90cb298dc36161abb388d9748d46613be44dc4bc1409efe0b09 |
|
MD5 | 2b3a6995827538dfa5052cb8edab2d25 |
|
BLAKE2b-256 | 91115f44df98c9187d220c6d9d48aaead91a7dac93b527597802396fb5bd550b |