Merge pull request #68 from IMMM-SFA/release-notes

JOSS Review: Release notes and PR template

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,24 @@
+**Purpose:**
+
+Short description of the purpose of this PR
+
+**New version:**
+
+Then new version number if one is to be issued
+
+**Related:**
+
+Any related pull requests or issues from other repositories
+
+**Resolved:**
+
+Any issues to resolve automatically upon merge.  Use the keyword with the number of the target issue (e.g., `Resolve #59`)
+
+**Incorporated:**
+
+Any pull requests already merged that this one may include.  This is usually the case when feature and bug fix branches have been merged into the `dev` branch then these are staged to be merged into the `main`
+
+
+**Comments:**
+
+Any additional comments.

cerf/__init__.py

@@ -8,4 +8,4 @@
 from .install_supplement import install_package_data
 
 
-__version__ = "2.0.5"
+__version__ = "2.0.6"

cerf/install_supplement.py

@@ -23,7 +23,8 @@ class InstallSupplement:
                          '2.0.2': 'https://zenodo.org/record/5218436/files/cerf_package_data.zip?download=1',
                          '2.0.3': 'https://zenodo.org/record/5218436/files/cerf_package_data.zip?download=1',
                          '2.0.4': 'https://zenodo.org/record/5247690/files/cerf_package_data.zip?download=1',
-                         '2.0.5': 'https://zenodo.org/record/5247690/files/cerf_package_data.zip?download=1'}
+                         '2.0.5': 'https://zenodo.org/record/5247690/files/cerf_package_data.zip?download=1',
+                         '2.0.6': 'https://zenodo.org/record/5247690/files/cerf_package_data.zip?download=1'}
 
     def fetch_zenodo(self):
         """Download and unpack the Zenodo example data supplement for the

docs/source/conf.py

@@ -16,7 +16,7 @@
 import sphinx_rtd_theme
 
 # import cerf
-version = "2.0.5" #str(cerf.__version__)
+version = "2.0.6" #str(cerf.__version__)
 
 
 sys.path.insert(0, os.path.abspath('../../'))

docs/source/index.rst

@@ -98,6 +98,7 @@ cerf documentation
    user_guide
    modules
    contributing
+   release_notes
    publications
    how_to_cite
    authors

docs/source/release_notes.rst

@@ -0,0 +1,121 @@
+Release notes
+=============
+
+This is the list of changes to **cerf** between each release. For full details,
+see the `commit logs <https://github.com/IMMM-SFA/cerf/commits>`_.
+
+
+Version 2.0.6
+_____________
+
+Changes made in `PR #68 <https://github.com/IMMM-SFA/cerf/pull/68>`_
+
+- Added release notes to documentation
+- Added template for pull requests
+
+
+Version 2.0.5
+_____________
+
+Changes made in `PR #65 <https://github.com/IMMM-SFA/cerf/pull/65>`_
+
+- Remove data file that was not ignored
+
+
+Version 2.0.4
+_____________
+
+Changes made in `PR #64 <https://github.com/IMMM-SFA/cerf/pull/64>`_
+
+- Generalization of variables to non-US-specific names throught the code and documentation (e.g., change states to regions)
+- Added generalization section into docs
+- Add in support statement for Ubuntu 18
+
+
+Version 2.0.3
+_____________
+
+Changes made in `PR #55 <https://github.com/IMMM-SFA/cerf/pull/55>`_
+
+- Add `unit_size` to outputs
+- Change package data to install data protocol from Zenodo fetch
+
+
+Version 2.0.2
+_____________
+
+Changes made in `PR #49 <https://github.com/IMMM-SFA/cerf/pull/49>`_
+
+- Add ``unit_size`` to outputs
+- Change package data to install data protocol from Zenodo fetch
+
+
+Version 2.0.1
+_____________
+
+Skipped release.
+
+
+Version 2.0.0
+_____________
+
+- Add tests for package data, prep for JOSS paper submission
+
+
+Version 2.0.0-beta.5
+____________________
+
+- Update codecov target
+
+
+Version 2.0.0-beta.4
+____________________
+
+- Modify quickstarter to calculate interconnection cost rather than load it from file
+
+
+Version 2.0.0-beta.3
+____________________
+
+- Updated install packages list in setup.py for pip
+
+
+Version 2.0.0-beta.2
+____________________
+
+- Updated email protocol in setup.py
+
+
+Version 2.0.0-beta.1
+____________________
+
+- Added download URL
+
+
+Version 2.0.0-beta.0
+____________________
+
+This release represents a completely reimagined cerf hosting the following improvements and capabilities:
+
+- Full Python implementation
+- Complete rebuild of all functionality
+- Quick solution competition algorithm
+- No longer Windows 7 dependent; runs on all OSs
+- New YAML configuration structure
+- Massive performance improvements
+- Modular reconstruction
+- On-the-fly interconnection infrastructure building from source spatial products
+- Migration to substations for interconnection
+- Flexible naming conventions
+- Sample and demonstration package data
+- Test suite
+- Full sphinx documentation served on github.io
+- Locational marginal price module now calculates from 8760 hourly zonal input
+- Selectable parallelization strategy for embarrassingly parallel processing of US states
+- Much more!
+
+
+Version 1.0.0
+_____________
+
+- Initial release