Merge pull request #22 from rmi-electricity/dev

Updates for 0.3

Author: arengel

.github/workflows/documentation.yml

@@ -1,5 +1,7 @@
 name: docs
 on: [push, pull_request, workflow_dispatch]
+permissions:
+  contents: write
 jobs:
   docs:
     runs-on: ubuntu-latest

.github/workflows/tox-pytest.yml

@@ -37,3 +37,19 @@ jobs:
       - name: Run PyTest with Tox
         run: |
           conda run -n dispatch tox
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./coverage.info
+
+  finish:
+    needs: ci-test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true

.gitignore

@@ -50,6 +50,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.info
 *.cover
 *.py,cover
 .hypothesis/
@@ -149,3 +150,7 @@ Thumbs.db
 
 # Dispatch
 *.zip
+*.ipynb
+!tests/data/*.zip
+
+/src/dispatch/_version.py

.pre-commit-config.yaml

@@ -124,15 +124,15 @@ repos:
     rev: v1.0.0
     hooks:
       - id: doc8
-        args: ["--config", "tox.ini"]
+        args: ["--config", "pyproject.toml"]
 
   # Lint any RST files and embedded code blocks for syntax / formatting errors
   - repo: https://github.com/myint/rstcheck
     rev: v6.1.0
     hooks:
       - id: rstcheck
-        additional_dependencies: [sphinx]
-        args: ["--config", "tox.ini"]
+        additional_dependencies: ["rstcheck[toml, sphinx]"]
+        args: ["--config", "pyproject.toml"]
 
   ########################################################################################
   # Custom local hooks

README.rst

@@ -6,6 +6,13 @@ Dispatch: A simple and efficient electricity dispatch model
    :target: https://github.com/rmi-electricity/dispatch/actions?query=workflow%3Atox-pytest
    :alt: Tox-PyTest Status
 
+.. image:: https://github.com/rmi-electricity/dispatch/workflows/docs/badge.svg
+   :target: https://rmi-electricity.github.io/dispatch/
+   :alt: GitHub Pages Status
+
+.. image:: https://coveralls.io/repos/github/rmi-electricity/dispatch/badge.svg?branch=dev
+   :target: https://coveralls.io/github/rmi-electricity/dispatch?branch=dev
+
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black>
    :alt: Any color you want, so long as it's black.
@@ -36,9 +43,22 @@ For more information about how the model works and how to use it, please see the
 
 Installation
 =======================================================================================
+
 Dispatch can be installed and used in it's own environment or installed into another
-environment using pip. To create an environment for Dispatch, navigate to the repo
-folder in terminal and run:
+environment using pip. To install it using pip:
+
+.. code-block:: bash
+
+   $ pip install git+https://github.com/rmi-electricity/dispatch.git
+
+Or from the dev branch:
+
+.. code-block:: bash
+
+   $ pip install git+https://github.com/rmi-electricity/dispatch.git@dev
+
+
+To create an environment for Dispatch, navigate to the repo folder in terminal and run:
 
 .. code-block:: bash
 

docs/conf.py

@@ -12,9 +12,11 @@
 from datetime import datetime
 from pathlib import Path
 
-import pkg_resources
+# import pkg_resources
 from sphinx.application import Sphinx
 
+from dispatch import __version__ as version
+
 DOCS_DIR = Path(__file__).parent.resolve()
 
 # -- Path setup --------------------------------------------------------------
@@ -24,7 +26,7 @@
 # importable path.
 
 # The full version, including alpha/beta/rc tags
-release = pkg_resources.get_distribution("rmi.dispatch").version
+release = ".".join(version.split(".")[:2])
 
 # -- Project information -----------------------------------------------------
 
@@ -98,13 +100,28 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/rmi-electricity/dispatch",
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+            </svg>
+        """,
+            "class": "",
+        },
+    ],
     "navigation_with_keys": True,
     # "logo": {
     #     "image_light": "Small_PNG-RMI_logo_PrimaryUse.PNG",
     #     "image_dark": "Small_PNG-RMI_logo_PrimaryUse_White_Horizontal.PNG",
     # },
     "light_logo": "Small_PNG-RMI_logo_PrimaryUse.PNG",
     "dark_logo": "Small_PNG-RMI_logo_PrimaryUse_White_Horizontal.PNG",
+    "source_repository": "https://github.com/rmi-electricity/dispatch/",
+    "source_branch": "main",
+    "source_directory": "docs/",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/release_notes.rst

@@ -5,7 +5,7 @@ Release Notes
 .. _release-v0-3-0:
 
 ---------------------------------------------------------------------------------------
-0.3.0 (2022-XX-XX)
+0.3.0 (2022-10-08)
 ---------------------------------------------------------------------------------------
 
 What's New?
@@ -32,15 +32,26 @@ What's New?
 *   Added validation steps for each type of specs that raise an error when an
     operating_date is after the dispatch period which would otherwise result in
     dispatch errors.
+*   New helpers (:func:`.dfs_to_zip` and :func:`.dfs_from_zip`) that simplify saving
+    and reading in groups of :class:`pandas.DataFrame`.
+*   Added plotting functions :meth:`.DispatchModel.plot_period` and
+    :meth:`.DispatchModel.plot_year`.
 
 Known Issues
 ^^^^^^^^^^^^
 *   :meth:`.DispatchModel.re_summary` and :meth:`.DispatchModel.storage_summary` have
-    operations cost data.
-*   :meth:`.DispatchModel.re_summary` and :meth:`.DispatchModel.storage_summary` have
-    no tests.
+    null operations cost data.
 *   There is still no nice way to include nuclear and hydro resources.
+*   :meth:`.DispatchModel.plot_year` doesn't seem to really work. At all.
+
 
+Bug Fixes
+^^^^^^^^^
+*   A validation check throws an error when ramp rates are zero which otherwise would
+    prevent plant output from ever changing on a fresh dispatch.
+*   Fixed a :exc:`TypeError` issue in :func:`.apply_op_ret_date` when some dates were
+    inexplicably converted to :class:`int` rather than :class:`numpy.datetime64` by
+    :meth:`pandas.DataFrame.to_numpy`.
 
 .. _release-v0-2-0:
 

pyproject.toml

@@ -3,6 +3,7 @@ requires = ["setuptools<64", "setuptools_scm"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
+write_to = "src/dispatch/_version.py"
 
 [tool.black]
 line-length = 88
@@ -30,3 +31,26 @@ module = [
     "numba.*"
 ]
 ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["."]
+addopts = ["--verbose"]
+log_format = "%(asctime)s [%(levelname)8s] %(name)s:%(lineno)s %(message)s"
+log_date_format=" %Y-%m-%d %H:%M:%S"
+log_cli = true
+log_cli_level = "INFO"
+doctest_optionflags = ["NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL", "ELLIPSIS"]
+filterwarnings = [
+    "ignore:distutils Version classes are deprecated:DeprecationWarning",
+    "ignore:Creating a LegacyVersion:DeprecationWarning:pkg_resources[.*]",
+]
+
+[tool.doc8]
+max-line-length = 88
+ignore-path = "docs/_build"
+
+[tool.rstcheck]
+report_level = "WARNING"
+ignore_roles = ["pr", "issue", "user", "include"]
+ignore_messages = '(Hyperlink target .* is not referenced\.$|Duplicate implicit target name:|An `AttributeError` error occured.*)'
+ignore_directives = ["bibliography", "todo", "include"]

setup.cfg

@@ -37,7 +37,7 @@ dev =
     tox>=3.20,<3.27
 doc =
     doc8>=0.9,<1.1
-    sphinx>=4,!=5.1.0,<5.2.3
+    sphinx>=4,!=5.1.0,<5.2.4
     sphinx-autoapi>=1.8,<2.1
     sphinx-autodoc-typehints
     sphinxcontrib-mermaid
@@ -47,7 +47,7 @@ tests =
     ; Checks code for security issues
     bandit>=1.6,<1.8
     ; Lets us track what code is being tested
-    coverage>=5.3,<6.5
+    coverage>=5.3,<6.6
     ; Ensures clean documentation formatting
     doc8>=0.9,<1.1
     ; A framework for linting & static analysis
@@ -63,7 +63,7 @@ tests =
     ; Checks that code isn't overly complicated
     mccabe>=0.6,<0.8
     ; Static type checking
-    mypy>=0.942,<0.982
+    mypy>=0.942,<0.983
     ; Require PEP8 compliant variable names
     pep8-naming>=0.12,<0.14
     ; Allow us to run pre-commit hooks in testing
@@ -74,9 +74,9 @@ tests =
     ; Allow automatic testing of scripts
     pytest-console-scripts>=1.1,<1.4
     ; Pytest plugin for working with coverage
-    pytest-cov>=2.10,<3.1
+    pytest-cov>=2.10,<4.1
     ; ReStructuredText linter
-    rstcheck[sphinx]>=5.0,<6.2
+    rstcheck[sphinx,toml]>=5.0,<6.2
     ; Python test environment manager
     tox>=3.20,<3.27
 ;    pandas-stubs

src/dispatch/__init__.py

@@ -1,9 +1,27 @@
 """A template repository for a Python package created by Catalyst Cooperative."""
 import logging
-from importlib.metadata import PackageNotFoundError, version
+
+__author__ = "RMI"
+__contact__ = "[email protected]"
+__maintainer__ = "Alex Engel"
+__license__ = "BSD 3-Clause License"
+__maintainer_email__ = "[email protected]"
+__docformat__ = "restructuredtext en"
+__description__ = "A simple and efficient dispatch model."
+
+try:
+    from dispatch._version import version as __version__
+except ImportError:
+    __version__ = "unknown"
+
+# try:
+#     __version__ = version("rmi.dispatch")
+# except PackageNotFoundError:
+#     # package is not installed
+#     pass
 
 from dispatch.engine import dispatch_engine, dispatch_engine_compiled
-from dispatch.helpers import apply_op_ret_date, copy_profile
+from dispatch.helpers import apply_op_ret_date, copy_profile, dfs_from_zip, dfs_to_zip
 from dispatch.model import DispatchModel
 
 __all__ = [
@@ -12,22 +30,11 @@
     "dispatch_engine_compiled",
     "copy_profile",
     "apply_op_ret_date",
+    "dfs_to_zip",
+    "dfs_from_zip",
+    "__version__",
 ]
 
-__author__ = "RMI"
-__contact__ = "[email protected]"
-__maintainer__ = "Alex Engel"
-__license__ = "BSD 3-Clause License"
-__maintainer_email__ = "[email protected]"
-__docformat__ = "restructuredtext en"
-__description__ = "A simple and efficient dispatch model."
-
-try:
-    __version__ = version("rmi.dispatch")
-except PackageNotFoundError:
-    # package is not installed
-    pass
-
 __projecturl__ = "https://github.com/rmi-electricity/dispatch"
 __downloadurl__ = "https://github.com/rmi-electricity/dispatch"