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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92c6c6608b695cea50ae428f9c114a81669ff819a0e385bd3bc7cc48672efaa4 |
|
MD5 | ffe0cc3cc334090f52e28e0e90733a96 |
|
BLAKE2b-256 | be30cb15559d7f5c10a7f43530288da6de76d0c2a0887c77e13c1c8f4d5311a4 |
Close
Hashes for urbanopt_ditto_reader-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfaf3fd905a1b93f53d0cfd7aeedf7863f295f5000876a565e08a0871ecbc899 |
|
MD5 | 7e4602d0782a48aa1a1266219b53962b |
|
BLAKE2b-256 | e79a348552011c39c04d00d24a383cb7cb5bf2a5d527fd6dcccbf5a4e729429c |