Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 3.22 KB

README.md

File metadata and controls

61 lines (45 loc) · 3.22 KB
Raw

CAISO Connector

Maintainability Build codecov Black

This project connects to the CAISO OASIS API and downloads daily Location Marginal Price (LMP) data. The CAISO payload comes in the form of a zip file. The zip file is unpacked through an ETL script. The ETL script parses the CSV for relevant data and persists data in a SQLite database.

This database was chosen because of its ease of install and availability on most operating systems. In a real production ETL, I would have used an AWS managed database.

Code documentation here

Install instructions

Run project from Docker container

  1. In a new directory, download repo

    docker-compose up
    • The previous command will build and start the necessary containers:
      • caiso_connector: contains REST API, and ETL worker
      • demo: plotly dashboard server

navigate to http://0.0.0.0:80/docs to interact with REST API

  1. Populate database

    TODO update this process

Outputs

  • This code generates a SQLite database located at src/lmp.db
  • Locally, a REST API is located at http://127.0.0.1:8000/docs
  • The code generates an interactive LMP chart LMP_plot.html. The chart can be rendered from the notebook LMP_plot.ipynb notebook, which is also rendered online here rendered notebook

Run tests

docker-compose exec web python -m pytest tests

which yields the following upon successful run

 ➜  caiso_connector git:(master) docker-compose exec web python -m pytest tests
============================ test session starts =============================
platform linux -- Python 3.7.7, pytest-5.3.2, py-1.8.1, pluggy-0.13.1
rootdir: /code
collected 7 items

tests/test_api.py .....                                                [ 71%]
tests/test_connector.py ..                                             [100%]

============================= 7 passed in 0.65s ==============================

References