Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release of version 2.3 #210

Merged
merged 8 commits into from
Nov 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

<!-- Release notes generated using configuration in .github/release.yml at master -->

## 2.3.0
### Highlights
This release adds a new algorithm for [output space exploration](https://emaworkbench.readthedocs.io/en/latest/ema_documentation/em_framework/outputspace_exploration.html). The way in which convergence tracking for optimization is supported has been overhauled completely, see the updated [directed search](https://emaworkbench.readthedocs.io/en/latest/indepth_tutorial/directed-search.html) user guide for full details. The documentation has moreover been expanded with a [comparison to Rhodium](https://emaworkbench.readthedocs.io/en/latest/getting_started/other_packages.html).

With this new release, the installation process has been improved by reducing the number of required dependencies. Recommended packages and connectors can now be installed as _extras_ using pip, for example `pip install -U ema-workbench[recommended,netlogo]`. See the [updated installation instructions](https://emaworkbench.readthedocs.io/en/latest/getting_started/installation.html) for all options and details.

The 2.3.x release series supports Python 3.8 to 3.11. It can be installed as usual via PyPI, with:
```
pip install --upgrade ema-workbench
```

### What's Changed

#### 🎉 New features added
* Output space exploration by @quaquel in https://github.com/quaquel/EMAworkbench/pull/170
* Convergence tracking by @quaquel in https://github.com/quaquel/EMAworkbench/pull/193

### 🛠 Enhancements made
* Switch to using format string in prim logging by @quaquel in https://github.com/quaquel/EMAworkbench/pull/161
* Replace setup.py with pyproject.toml and implement optional dependencies by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/166

#### 🐛 Bugs fixed
* use masked arrays for storing outcomes by @quaquel in https://github.com/quaquel/EMAworkbench/pull/176
* Fix error for negative `n_processes` input in MultiprocessingEvaluator by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/189
* optimization.py: Fix "epsilons" keyword argument in `_optimize()` by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/150

#### 📜 Documentation improvements
* Create initial CONTRIBUTING.md documentation by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/162
* Create Read the Docs yaml configuration by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/173
* update to outcomes documentation by @quaquel in https://github.com/quaquel/EMAworkbench/pull/183
* Improved directed search tutorial by @quaquel in https://github.com/quaquel/EMAworkbench/pull/194
* Update Contributing.md with instructions how to merge PRs by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/200
* Update Readme with an introduction and documentation, installation and contribution sections by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/199
* Rhodium docs by @quaquel in https://github.com/quaquel/EMAworkbench/pull/184
* Fix spelling mistakes by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/195

#### 🔧 Maintenance
* Replace depreciated `shade` keyword in Seaborn kdeplot with `fill` by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/169
* CI: Add pip depencency caching, don't run on doc changes, update setup-python to v4 by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/174
* Formatting: Format with Black, increase max line length to 100, combine multi-line blocks by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/178
* Add pre-commit configuration and auto update CI by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/181
* Fix Matplotlib, ipyparallel and dict deprecation warnings by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/202
* CI: Start testing on Python 3.11 by @EwoutH in https://github.com/quaquel/EMAworkbench/pull/156
* Replace deprecated `saltelli` with `sobol` SALib 1.4.6+. by @quaquel in https://github.com/quaquel/EMAworkbench/pull/211

#### Other changes
* Adds CITATION.cff by @quaquel in https://github.com/quaquel/EMAworkbench/pull/209

**Full Changelog**: https://github.com/quaquel/EMAworkbench/compare/2.2.0...2.3

## 2.2.0
### Highlights
With the 2.2 release, the EMAworkbench can now connect to [Vadere](https://www.vadere.org/) models on pedestrian dynamics. When inspecting a Prim Box peeling trajectory, multiple points on the peeling trajectory can be inspected simultaneously by inputting a list of integers into [`PrimBox.inspect()`](https://emaworkbench.readthedocs.io/en/latest/ema_documentation/analysis/prim.html#ema_workbench.analysis.prim.PrimBox.inspect).
Expand Down
2 changes: 1 addition & 1 deletion ema_workbench/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@

# from . import analysis

__version__ = "2.3.0-dev"
__version__ = "2.3.0"