Ding0 visualization

Visualize synthetic distribution grid data generated by ding0 with D3.

Installation

Create a virtual environment for python

conda create -n dingo_visualization python=3 
conda activate dingo_visualization
pip install -r python_requirements.txt

and you're ready to retrieve and process data.

For generating and deploying the site with Jekyll, you need to have Ruby installed. To install it, run

sudo apt install ruby-bundler

To install Ruby dependencies, run

bundle

and packages specified in Gemfile are installed.

In addition install jekyll (might require sudo)

gem install jekyll bundler

Trouble shooting

During the installation of ruby dependencies (bundle) you might encounter the following error

An error occurred while installing eventmachine (1.2.7), and Bundler cannot
continue.
Make sure that `gem install eventmachine -v '1.2.7'` succeeds before bundling.

Install the following

sudo apt-get install ruby-dev

Retrieve data

Use the command-line interface, for example

python utils/retrieve_data.py --grid_id 632

You can also the _config.yml file or a custom config file. See the help with python utils/retrieve_data.py.

Order of input processing (top overwrites bottom)

Command-line arguments
Custom conifg file
Default config file _config.yml

Process data

Use the CLI

python utils/process_data.py

and see help by python utils/process_data.py -h. By default, it processes all CSV files available in the default CSV file location.

If you have a bunch of ding0 data in CSV files already saved to different path, use

python utils/process_data.py --csv_data_path /path/to/csv/files

Default data structure

By default, csv and geojson data file are organized as follows

ding0_viz/data
├── csv
│   └── 629
│       ├── buses_629.csv
│       ├── generators_629.csv
│       ├── lines_629.csv
│       ├── loads_629.csv
│       ├── network_629.csv
│       └── transformers_629.csv
└── geojson
    ├── 629
    │   ├── mv_grid_district_629.geojson
    │   ├── mv_visualization_generator_data_629.geojson
    │   ├── mv_visualization_line_data_629.geojson
    │   └── mv_visualization_transformer_data_629.geojson
    └── available_grid_data.txt

data/ is a local (not in the repository) subdirectory in the root path of the repository. The location of GeoJSON files (data/geojson)

Deploy and serve

The site is built with Jekyll. Use the following command (inside the repo's root directory)

jekyll serve -o

to build site (found in _site) and serve the it at localhost:4000. The option -o opens a new tab in your browser showing the site.

Jekyll provides tons of configuration options.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

gplssm/ding0_viz