Skip to main content

An API for examing the EIA Monthly Energy Review datasets.

Project description

pyleiades

Build Status

Python Library for EIA Data Examination & Exhibition

A tool for creating visuals from historical energy data (e.g. the EIA monthly energy review).

This tool is designed to provide insightful, aesthetic and more flexible visualizations of the Energy Information Administration (EIA) monthly energy review datasets. The datasets contain information about the sources of energy Americans have relied on for power since the middle of the 20th century. The datasets begin in 1949 with annual energy production, consumption, import, and export values, and extend up until the present. Monthly energy datapoints are reported starting in 1973.

The basic energy sources are reported in the following groups:

Fossil Fuels
  • Coal
  • Natural Gas
  • Petroleum
Renewables
  • Wind
  • Solar
  • Hydroelectric
  • Geothermal
  • Biomass
Nuclear
  • Fission

The data is published monthly on the EIA's website, and as of March 31st, 2019 records were provided up through December 2018. This package also includes data up to date through the end of 2018, though more recent data can be downloaded using an included script.

All reported values are in units of quadrillion british thermal units (1.0E15 btu). Be aware that the datasets may provide more precision than is published in the PDF reports.

Installation

pyleiades is hosted through the Python Package Index (PyPI) and can be easily installed using pip. From the command line, run

pip install pyleiades

The module requires a recent version of python 3 (3.6 or greater), pandas, and matplotlib, among others. If you run into trouble running the package, try using the Anaconda environment provided in this repo. Install the environment using the command

conda env create -f environment.yml

and activate the environment by issuing the command

conda activate pyleiades

Updating

An archive of EIA Monthly Energy Review datasets is kept in the pyleiades data repository. This may not include the most up to date information, and so the package comes with a script to update the available data. Once the package is installed, run

update_eia_data.py

from the command line to download the most recent data from the EIA website.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyleiades-0.0.0.dev5.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyleiades-0.0.0.dev5-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file pyleiades-0.0.0.dev5.tar.gz.

File metadata

  • Download URL: pyleiades-0.0.0.dev5.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for pyleiades-0.0.0.dev5.tar.gz
Algorithm Hash digest
SHA256 3754afd2a49d36607e8eee7b786ca8290b63a6e602856ef87a5493d075105a8f
MD5 1732c910505a48b42ce0c81c6dec1933
BLAKE2b-256 5c2128acb27fcb995ec223d27c6216e4b4a9e55af630c7579ff9bd6f7882132e

See more details on using hashes here.

File details

Details for the file pyleiades-0.0.0.dev5-py3-none-any.whl.

File metadata

  • Download URL: pyleiades-0.0.0.dev5-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for pyleiades-0.0.0.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 8260f0dfe51e6a26c73c5611a60333ac6f2956b09e5ea3dc7c9cc9194eb58864
MD5 846557de075bbd38f69e43c511002070
BLAKE2b-256 2479fbb1d94c4f68d119943d9fcb053408d5743804565b93cf9cc0c18e7f4843

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page