Added release notes and version bump for dymos 1.10.0 (#1022)

* added release notes for dymos 1.10.0 * bump version to 1.10.0 * Fixed release notes mention of vanderpol update.
OpenMDAO · Dec 8, 2023 · a1e5e21 · a1e5e21
1 parent b1ddc16
commit a1e5e21
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 5 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.9.2-dev
+current_version = 1.10.0
 commit = True
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -23,7 +23,7 @@ body:
     attributes:
       label: Dymos Version
       description: What version of Dymos is being used.
-      placeholder: "1.9.2-dev"
+      placeholder: "1.10.0"
     validations:
       required: true
   - type: textarea

diff --git a/docs/dymos_book/examples/finite_burn_orbit_raise/finite_burn_orbit_raise.ipynb b/docs/dymos_book/examples/finite_burn_orbit_raise/finite_burn_orbit_raise.ipynb
@@ -421,7 +421,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/dymos/__init__.py b/dymos/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '1.9.2-dev'
+__version__ = '1.10.0'
 
 
 from .phase import Phase, AnalyticPhase

diff --git a/release_notes.md b/release_notes.md
@@ -1,3 +1,40 @@
+*******************************
+# Release Notes for Dymos 1.10.0
+
+December 08, 2023
+
+Dymos 1.10.0 includes a few performance improvements, more user-configurability of automatic solver placement, and a still-experimental implementation of the Birkhoff transcription.
+
+Thanks to Shugo Kaneko for pointing out some issues with using dymos under MPI.
+Timeseries jacobians were inefficient and used excessive memory when operating on a single system under MPI.
+Also, the user now has more control over how solvers are added when necessary. Previously, the presence of a DirectSolver over a distributed system was causing an error.
+
+Trajectory now has a `parallel_phases` option. When True (the default), the top level `Trajectory.phases` container will be an OpenMDAO ParallelGroup. Setting it to `False` makes `Trajectory.phases` a standard serial `OpenMDAO.api.Group` object.
+
+Trajectory and Phase now both have an `auto_solvers` option. It is enabled by default and will result in appropriate nonlinear and linear solvers being placed when it is `True`.
+Trajectory.phases needs a nonlinear solver when running phases in parallel under MPI AND the phases are directly connected.
+Phases need a solver when there is implicit behavior due to a duration balance or the use of `solve_segments` is pseudospectral phases.
+
+## Backwards Incompatible API Changes & Deprecations
+- None
+
+## Enhancements
+- Reduce memory usage for timeseries jac computation [#1001](https://github.com/OpenMDAO/dymos/pull/1001)
+- Added Birkhoff Transcription (this feature is still somewhat experimental) [#1008](https://github.com/OpenMDAO/dymos/pull/1008) [#1010](https://github.com/OpenMDAO/dymos/pull/1010) [#1021](https://github.com/OpenMDAO/dymos/pull/1021)
+
+## Bug Fixes
+- Fixed python 3.12 compatibility issues. [#1004](https://github.com/OpenMDAO/dymos/pull/1004)
+- Fixed load_case logic to correctly handle negative-duration phases [#1007](https://github.com/OpenMDAO/dymos/pull/1007)
+- Boundary constraints in Birkhoff transcription changed to pull from boundary ODE [#1018](https://github.com/OpenMDAO/dymos/pull/1018)
+- Fixed an issue where applying DirectSolver to StateIndependentsComp was breaking when used with other linear solvers under MPI. [#1020](https://github.com/OpenMDAO/dymos/pull/1020)
+- Fixed Vanderpol example under updated OpenMDAO MPI operation. [#1023](https://github.com/OpenMDAO/dymos/pull/1023)
+
+## Miscellaneous
+- Added a job without MPI to the test workflow [#998](https://github.com/OpenMDAO/dymos/pull/998)
+- Removed redundant implementations of timeseries output components. [#1005](https://github.com/OpenMDAO/dymos/pull/1005)
+- Remove IVCs from control groups [#1013](https://github.com/OpenMDAO/dymos/pull/1013)
+
+
 *******************************
 # Release Notes for Dymos 1.9.1
 

diff --git a/setup.py b/setup.py
@@ -45,7 +45,7 @@
 
 
 setup(name='dymos',
-    version='1.9.2-dev',
+    version='1.10.0',
     description='Open-Source Optimization of Dynamic Multidisciplinary Systems',
     long_description='''
 Dymos is a framework for the simulation and optimization of dynamical systems within the OpenMDAO Multidisciplinary Analysis and Optimization environment.