Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
awadell1 committed Oct 27, 2023
1 parent f513ab2 commit 47208b5
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# Scaling Behavior for Electric Vehicle Chargers and Road Map to Addressing the Infrastructure Gap

[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/BattModels/evse-scaling-behavior/blob/main/PredictionMap.ipynb)
[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.5784659-blue)](https://doi.org/10.5281/zenodo.5784659)
![Paper](https://img.shields.io/badge/Paper-10.1093%2Fpnasnexus%2Fpgad341-purple)
[![Dataset](https://img.shields.io/badge/Data-10.5281%2Fzenodo.5784659-blue)](https://doi.org/10.5281/zenodo.5784659)
![GitHub](https://img.shields.io/github/license/BattModels/evse-scaling-behavior)

Source code and [interactive demo](https://colab.research.google.com/github/BattModels/evse-scaling-behavior/blob/main/PredictionMap.ipynb) for _Scaling Behavior for Electric Vehicle Chargers and Road Map to Addressing the Infrastructure Gap_.
<p align="center">
<a href="https://battmodels.github.io/evse-scaling-behavior/map.html">
<img src="docs/assets/ev_pop_residuals.svg" width="60%">
</a>
</p>

Source code and [interactive demo](https://battmodels.github.io/evse-scaling-behavior/map.html) for [_Scaling Behavior for Electric Vehicle Chargers and Road Map to Addressing the Infrastructure Gap_](https://doi.org/10.1093/pnasnexus/pgad341).

## Getting the Data

The processed dataset, as used in the paper for model fitting, is available at
[data/dataset.csv](data/dataset.csv). The source datasets, as documented in the supporting
information, were collected from the following sources:
[data/dataset.csv](data/dataset.csv). The source datasets, as documented in the [supporting
information](https://academic.oup.com/pnasnexus/article-lookup/doi/10.1093/pnasnexus/pgad341#supplementary-data), were collected from the following sources:

| Source | Relevant Files | Source |
|--------|----------------|--------|
Expand All @@ -24,15 +29,15 @@ information, were collected from the following sources:
> More precise references, particularly for US Census data, are available in the
> supporting information.
Script for processing the various raw source dataset have also been provided.
Script for processing the various raw source datasets have also been provided.
Please note that this remains a largely manual process. For example, the PA
passenger vehicle registration reports were manually transcribed from the
source pdf. Further,
the data extraction scripts, particularly for state registration data, are highly
sensitive to data inputs, and their outputs should be manually verified.

- State Registrations:
- State-By-State Preprocessing: See the `parse*` scripts located in State's folder.
- State-By-State Preprocessing: See the `parse*` scripts located in the State's folder.
- Collating States: `data/state_registration/extract_passenger_vehicles.py`
- EV Registrations
- Makefile for fetching new results: `data/ev_registration/makefile`
Expand All @@ -46,7 +51,7 @@ sensitive to data inputs, and their outputs should be manually verified.
## Unprocessed Data

Due to size constraints, this repository does not provide the unprocessed data files
used to develop our dataset. It can be found at: https://doi.org/10.5281/zenodo.5784659
used to develop our dataset. It can be found at: <https://doi.org/10.5281/zenodo.5784659>

## Replicating the Analysis

Expand Down Expand Up @@ -100,5 +105,3 @@ to the `img-docker/` directory on the host machine.
### Building the Container

The docker image can be built using: `docker build -t evse-scaling:latest .`


0 comments on commit 47208b5

Please sign in to comment.