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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bbdd8fe0ab6a36e61c430c2d877981873acc4745cd313a53f39f19dc7c38083 |
|
MD5 | e73fbdc07e275cace3ee9ed447908eb1 |
|
BLAKE2b-256 | 2a877dd4a2df8273208f6a45845bc730bd7ef367f22dcf711a994db9317afa01 |
Close
Hashes for urbanopt_ditto_reader-0.3.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee2a94026e99da8cb888cef462887e6f4abdf4ef4ff4325efb09f0c7335ea73a |
|
MD5 | 0ea53577e972726155e7af3755499fe8 |
|
BLAKE2b-256 | 8572a8fa62e74c33c7ac60f1d8ba3f4e5c56cf3feb1b8496281909b5065dda58 |