Metadata-Version: 2.1
Name: dsgrid-legacy-efs-api
Version: 0.4.0
Summary: Python API for accessing demand-side grid model (dsgrid) data produced for the Electrification Futures Study (EFS)
Home-page: https://github.com/dsgrid/dsgrid-legacy-efs-api
Author: NREL
Author-email: elaine.hale@nrel.gov
License: BSD-3
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: h5py
Requires-Dist: layerstack
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: webcolors
Provides-Extra: dev
Requires-Dist: ghp-import ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: pandoc ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Provides-Extra: export
Requires-Dist: pyspark ; extra == 'export'
Provides-Extra: ntbks
Requires-Dist: jupyter ; extra == 'ntbks'
Requires-Dist: matplotlib ; extra == 'ntbks'
Provides-Extra: oedi
Requires-Dist: h5pyd ; extra == 'oedi'
Requires-Dist: s3fs ; extra == 'oedi'

dsgrid-legacy-efs-api
=====================

[![PyPI](https://img.shields.io/pypi/v/dsgrid-legacy-efs-api.svg)](https://pypi.python.org/pypi/dsgrid-legacy-efs-api/) [![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](https://dsgrid.github.io/dsgrid-legacy-efs-api)

dsgrid-legacy-efs-api is a Python API for accessing demand-side grid model (dsgrid) data produced for the [Electrification Futures Study (EFS)](https://www.nrel.gov/analysis/electrification-futures.html)

## Installation

To get the basic package, run:

```
pip install dsgrid-legacy-efs-api
```

If you would like to run the example notebooks and browse the files available 
through the Open Energy Data Initiative (OEDI), install the required extra 
dependencies:

```
pip install dsgrid-legacy-efs-api[ntbks,oedi]
```

and also clone the repository. Then you should be able to run the .ipynb files 
in the dsgrid-legacy-efs-api/notebooks folder, which include functionality for 
directly browsing the OEDI [oedi-data-lake/dsgrid-2018-efs](https://data.openei.org/s3_viewer?bucket=oedi-data-lake&prefix=dsgrid-2018-efs%2F) data files. If you would like 
to use the HSDS service, please see the configuration instructions at 
https://github.com/NREL/hsds-examples/.


