Merge branch 'release/0.4.0' into develop

CHANGELOG.md

@@ -0,0 +1,39 @@
+# LEAP CHANGES BY VERSION
+
+Being a terse compilation by version of changes.
+
+## 0.4.0, 9/19/2020
+
+* Significantly added to online [documentation](https://leap-gmu.readthedocs.io/en/latest/index.html)
+* Major code reorganization
+    * exception management for `Individual` has been moved to `RobustIndividual`
+    * `DistributedIndividual` now inherits from `RobustIndividual`
+    * `core.py` has been broken out to separate modules
+        * `Individual` and `RobustIndividual` now in `individual.py`
+        * representation specific entities moved to new sub-packages, `binary_rep`
+          and `real_rep`
+        * `Representation` now in `representation.py`
+        * `Decoder` now in `decoder.py`
+    * documentation, doctests, examples, Jupyter notebooks, and unit tests updated accordingly 
+* added ability to pass ancillary information during evaluation, such as UUIDs
+  that could be used to name output files and directories, yet do not have a 
+  direct impact on fitness
+
+## 0.3.1
+
+* Apply `Representation` consistently throughout LEAP, particulary the top-level monolithic functions
+* Added probe to `leap_ec.distributed.asynchronous.stead_state()` to take regular snapshots of the population
+
+## 0.3
+
+* fix how non-viable individuals sort themselves when compared since the prior method of comparing math.nan to math.nan yielded non-ideal behavior 
+* minor maintenance tweaks
+
+## 0.2
+
+* changed package name to `leap_ec` from `leap` to mitigate pypi namespace collisions
+* minor maintenance tweaks
+
+## 0.1
+
+* first major "mature" release of LEAP

docs/release_procedure.md

@@ -0,0 +1,18 @@
+# Release Procedure
+
+These are the things to do when performing a release.
+
+1. git checkout develop
+1. git pull 
+    > to ensure in sync with develop latest
+1. git flow release finish '<new release number>'
+1. update release number everywhere
+    1. `setup.py`
+    1. `docs/source/conf.py`
+        > this is for the ReadTheDocs version number
+1. update CHANGELOG.md
+1. if necessary sync `docs/source/roadmap.rst` with realistic expectations
+1. git flow release finish '<new release number'
+1. verify that the release number and final changes have properly propagated to:
+    1. github site
+    1. ReadTheDocs `master` and `latest` docs

docs/source/conf.py

@@ -24,9 +24,9 @@
 author = 'Jeffrey K. Bassett, Mark Coletti, and Eric O. Scott'
 
 # The short X.Y version
-version = '0.3'
+version = '0.4'
 # The full version, including alpha/beta/rc tags
-release = 'version 0.3.1'
+release = 'version 0.4.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/readme.rst

@@ -195,3 +195,15 @@ BiBTeX::
 
 .. bibliography:: leap.bib
     :cited:
+
+Acknowledgements
+----------------
+
+This effort used resources of the Oak Ridge Leadership Computing Facility for
+developing LEAP's distributed evaluation capability, and
+which is a DOE Office of Science User Facility supported under Contract
+DE-AC05-00OR22725.
+
+We would also like to thank the Department of Energy's Vehicle Technologies
+Office (VTO) for their funding support.
+

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='leap_ec',
-    version='0.3.1',
+    version='0.4.0',
     packages=find_packages(),
     license='Academic',
     author='Mark Coletti, Eric Scott, Jeff Bassett',