updates for 0.4.0 release

CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2025-02-06
+This update introduces some big new features to `Osier`.
+
+### Added
+- `Osier` includes a new "hierarchical dispatch" model for electricity dispatch (PR #71).
+- A new `nmga` module was added to facilitate "n-dimensional modeling-to-generate alternatives." (PR #72)
+- Two new tutorials in the documentation
+    * "Constraint" tutorial - how to constrain an `Osier` model with objective functions.
+    * "MGA" tutorial - how to perform MGA with `Osier`'s `nmga` module.
+- The "dispatch" tutorial demonstrates the hierarchical dispatch algorithm.
+
+### Fixed
+- Fixes an issue with GitHub actions that tried setting up a `conda` environment via Mambaforge (now deprecated).
+- Version listed in documentation is now linked with `pyproject.toml`.
+
 ## [0.3.1] - 2024-10-03
 ### Fixed
 - Migrates the `setup.py` to a `pyproject.toml` configuration file.

README.md

@@ -55,6 +55,12 @@ cd build/html
 python -m http.server
 ```
 
+```{note}
+Users attempting a local install need to make sure that they have `pandoc` installed.
+Please visit [`pandoc`'s documentation](https://pandoc.org/installing.html) for 
+instructions.
+```
+
 ## Examples
 
 The examples can be found in the `docs/source/examples/` directory. Alternatively, 

docs/source/conf.py

@@ -12,6 +12,7 @@
 #
 import os
 import sys
+import toml
 sys.path.insert(0, os.path.abspath('../..'))
 
 
@@ -22,7 +23,10 @@
 author = 'Samuel Dotson'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.1'
+with open("../../pyproject.toml", 'r') as file:
+    pyproject = toml.load(file)
+
+release = pyproject['project']['version']
 
 
 # -- General configuration ---------------------------------------------------

docs/source/index.md

@@ -3,10 +3,6 @@
 % You can adapt this file completely to your liking, but it should at least
 % contain the root `toctree` directive
 
-```{warning}
-This package is in active development.
-```
-
 ```{include} ../../README.md
 :relative-images:
 ```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name="osier"
-version = "0.3.1"
+version = "0.4.0"
 description = "osier: A justice oriented energy system optimization tool"
 readme = "README.md"
 keywords = ["energy systems", "optimization", "multi-objective", "justice", "multi-criteria decision"]
@@ -27,7 +27,8 @@ dependencies = [
     'pymoo',
     'pyentrp',
     'deap',
-    'pyomo'
+    'pyomo',
+    'toml'
 ]
 
 authors = [