Merge pull request #242 from Breakthrough-Energy/develop

Develop into Master

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# migrate code style to Black
+ce8d2bb1ee0da96a76a202982a9bcf2a6aae8666

.github/ISSUE_TEMPLATE/data-intake.md

@@ -0,0 +1,23 @@
+---
+name: Data Intake
+about: Investigate the use of external data
+title: Data Intake
+labels: data intake
+assignees: danielolsen, rouille
+
+---
+
+### Source
+* Name: ***e.g.*** Form EIA-923
+* Author: ***e.g.*** EIA
+* Description: ***e.g.*** Electric power data -- monthly and annually -- on electricity generation, fuel consumption, fossil fuel stocks, and receipts at the power plant and prime mover level for 2016
+* Source: ***e.g.*** https://www.eia.gov
+* Exact source location: ***e.g.*** https://www.eia.gov/electricity/data/eia923/
+* Terms (if specified): ***e.g.*** https://www.eia.gov/about/copyrights_reuse.php where it is written that we may use and/or distribute any of their data, files, databases, reports, graphs, charts, and other information products that are on their website
+
+### Destination
+* Modifications to source files(s): ***e.g.*** None
+* Location: postreise/...
+
+### General Purpose
+The data are used to ...

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+[Pull Request doc](https://breakthrough-energy.github.io/docs/user/git_guide.html#d-pull-request)
+
+### Purpose
+What is the larger goal of this change?
+
+### What the code is doing
+How is the purpose executed?
+
+### Testing
+How did you test this change (unit/functional testing, manual testing, etc.)? 
+
+### Where to look
+* It's helpful to clarify where your new code lives if you moved files around or there could be confusion/
+
+* What files are most important?
+
+### Usage Example/Visuals
+How the code can be used and/or images of any graphs, tables or other visuals (not always applicable). 
+
+### Time estimate
+How long will it take for reviewers and observers to understand this code change?

.github/workflows/docs-trigger.yml

@@ -0,0 +1,14 @@
+name: Update docs
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  dispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Breakthrough-Energy/actions/publish-docs@main
+        with:
+          token: ${{ secrets.CI_TOKEN_CLONE_REPO }} 

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  formatting:
+    if: "!contains(github.event.head_commit.message, 'skip_ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: python -m pip install --upgrade tox
+      - run: tox -e checkformatting
+  flake8:
+    if: "!contains(github.event.head_commit.message, 'skip_ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: python -m pip install --upgrade tox
+      - run: tox -e flake8

.github/workflows/packages.yml

@@ -0,0 +1,69 @@
+name: Update packages
+
+on: [workflow_dispatch]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout PostREISE
+        uses: actions/checkout@v2
+        with:
+          path: PostREISE
+
+      - name: Checkout PowerSimData
+        uses: actions/checkout@v2
+        with:
+          repository: Breakthrough-Energy/PowerSimData
+          path: PowerSimData
+
+      - name: Pipenv lock
+        id: pipenv_lock
+        uses: Breakthrough-Energy/actions/update-packages@main
+        with:
+          repo-dir: PostREISE
+
+      - name: Parse JSON
+        id: parse_json
+        run: |
+             additions=$(echo $json_summary | jq '.Additions')
+             additions="${additions//$'\n'/'%0A'}"
+             echo "::set-output name=additions::$additions"
+             deletions=$(echo $json_summary | jq '.Deletions')
+             deletions="${deletions//$'\n'/'%0A'}"
+             echo "::set-output name=deletions::$deletions"
+             updates=$(echo $json_summary | jq '.Updates')
+             updates="${updates//$'\n'/'%0A'}"
+             echo "::set-output name=updates::$updates"
+        env:
+          json_summary: ${{ steps.pipenv_lock.outputs.summary }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.CI_TOKEN_CLONE_REPO }}
+          commit-message: Update dependencies
+          title: Update dependencies
+          body: |
+            ### Summary of changes
+
+            - Additions
+            ```
+              ${{ steps.parse_json.outputs.additions }}
+            ```
+            - Deletions
+            ```
+              ${{ steps.parse_json.outputs.deletions }}
+            ```
+            - Updates
+            ```
+              ${{ steps.parse_json.outputs.updates }}
+            ```
+
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          branch: update-dependencies
+          path: PostREISE

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Pytest
+
+on: [push]
+
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, 'skip_ci')"
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8]
+
+    steps:
+      - name: Checkout PostREISE
+        uses: actions/checkout@v2
+        with:
+          path: PostREISE
+
+      - name: Checkout PowerSimData
+        uses: actions/checkout@v2
+        with:
+          repository: Breakthrough-Energy/PowerSimData
+          path: PowerSimData
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - run: python -m pip install --upgrade tox
+        working-directory: PostREISE
+
+      - run: tox -e pytest
+        working-directory: PostREISE

.gitignore

@@ -0,0 +1,142 @@
+# Location in which shapefiles will be downloaded as necessary
+postreise/plot/shapes/
+
+# Everything below taken from github/gitignore
+# https://github.com/github/gitignore/blob/master/Python.gitignore
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Editors
+.vscode/
+.idea/
+
+# Mac/OSX
+.DS_Store
+
+# Windows
+Thumbs.db