-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added release notes to documentation.
- Loading branch information
Showing
2 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,4 +36,5 @@ tutorial | |
| limitations | ||
| demonstrations | ||
| api | ||
| releases | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # Releases | ||
|
|
||
| ## 1.0.0 | ||
| * Released on April 13, 2021. | ||
| * We now offer you the best API Comsol has ever seen! 🎉 | ||
| * See ["Creating models: Python style"](https://mph.readthedocs.io/en/1.0/demonstrations.html#creating-models-python-style) for a feature demonstration. | ||
| * A new [`Node`](https://mph.readthedocs.io/en/1.0/api/mph.Node.html) class allows easy navigation of the model tree. | ||
| * The [`Model`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html) class relies internally on `Node` for most functionality. | ||
| * Feature nodes can be created with [`Model.create()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.create). | ||
| * Node properties can be read and written via [`Model.property()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.property). | ||
| * Feature nodes can be removed with [`Model.remove()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.remove). | ||
| * The [`Node`](https://mph.readthedocs.io/en/1.0/api/mph.Node.html) class has additional functionality for modifying the model. | ||
| * All feature nodes can now be [toggled](https://mph.readthedocs.io/en/1.0/api/mph.Node.html#mph.Node.toggle), not just physics features. | ||
| * [`Model.features()`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.features) and [`Model.toggle()`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.toggle) have been deprecated. | ||
| * Use the [`Node`](https://mph.readthedocs.io/en/1.0/api/mph.Node.html) class instead to access that functionality. | ||
| * [`Model.import_()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.import_) was introduced to supersede [`Model.load()`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.load). | ||
| * Arguments `unit` and `description` to [`Model.parameter()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.parameter) are deprecated. | ||
| * Parameter descriptions should now be accessed via [`Model.description()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.description). | ||
| * [`Model.parameters()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.parameters) now returns a dictionary [instead of named tuples](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.parameters). | ||
| * This is a breaking change, but in line with other parts of the API. | ||
| * [`mph.start()`](https://mph.readthedocs.io/en/1.0/api/mph.start.html) now picks a random free server port in client-server mode. | ||
| * This avoids collisions when starting multiple processes on Linux and macOS. | ||
| * Models may be [saved as](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.save) Java, Matlab, or VBA source files. | ||
| * [`mph.tree()`](https://mph.readthedocs.io/en/1.0/api/mph.tree.html) helps developers inspect the model tree in the console. | ||
| * Known issue: Navigating the model tree is slow in client–server mode. | ||
| * It is much faster in stand-alone mode, the default on Windows. | ||
| * Made folder search case-insensitive on Linux/macOS, as requested in [#31](https://github.com/MPh-py/MPh/issues/31). | ||
| * Documentation builds now use the [MyST parser](https://github.com/executablebooks/MyST-Parser) and the [Furo theme](https://github.com/pradyunsg/furo). | ||
|
|
||
| ## 0.9.1 | ||
| * Released on March 24, 2021. | ||
| * Added documentation chapter ["Demonstrations"](https://mph.readthedocs.io/en/0.9/demonstrations.html). | ||
| * Added [demo script](https://github.com/MPh-py/MPh/blob/72624ea6d92f009af07b3c7468084ab2a62dccfb/demos/worker_pool.py) that runs parallel Comsol sessions. | ||
| * Amended [`mph.start()`](https://mph.readthedocs.io/en/0.9/api/mph.start.html#mph.start) to allow hand-selecting the server port. | ||
| * This makes the demo script work reliably on Linux and macOS. | ||
| * Improved error handling at [server](https://mph.readthedocs.io/en/0.9/api/mph.Server.html#mph.Server) start-up. | ||
| * Relaxed log levels during [discovery](https://mph.readthedocs.io/en/0.9/api/mph.discovery.html) of Comsol installations. | ||
| * This suppresses possibly confusing log messages as described in [#28](https://github.com/MPh-py/MPh/issues/28). | ||
|
|
||
| ## 0.9.0 | ||
| * Released on March 10, 2021. | ||
| * [`mph.start()`](https://mph.readthedocs.io/en/0.9/api/mph.start.html) is now the preferred way to start a local Comsol session. | ||
| * On Windows, it starts a lightweight, stand-alone client. | ||
| * On Linux and macOS, it starts a thin client and local server. | ||
| * This is due to limitations on these platforms described in [issue #8](https://github.com/MPh-py/MPh/issues/8). | ||
| * Configuration options are exposed by [`mph.option()`](https://mph.readthedocs.io/en/0.9/api/mph.config.html#mph.config.option). | ||
| * An in-memory [cache](https://mph.readthedocs.io/en/0.9/api/mph.Client.html#mph.Client.caching) for previously loaded model files may be activated. | ||
| * Selection names are returned by [`model.selections()`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.selections). | ||
| * Feature names in physics interfaces are returned by [`model.features()`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.features). | ||
| * Feature nodes in physics interfaces can be [toggled](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.toggle) on or off. | ||
| * [Parameter](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.parameter) descriptions can be modified. | ||
| * [Parameter](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model.parameter) values may be returned as evaluated numbers instead of string expressions. | ||
| * Custom classes derived from [`Model`](https://mph.readthedocs.io/en/0.9/api/mph.Model.html#mph.Model) can now be more easily type-cast to. | ||
| * Users are warned if log-in details for the Comsol [server](https://mph.readthedocs.io/en/0.9/api/mph.Server.html#mph.Server) have not been set up. | ||
| * Fixes [issue #23](https://github.com/MPh-py/MPh/issues/23) regarding discovery with older Python versions on Windows. | ||
| * Fixes [issue #24](https://github.com/MPh-py/MPh/issues/24) regarding localized server output messages. | ||
|
|
||
| ## 0.8.2 | ||
| * Released on February 13, 2021. | ||
| * Works around issue of [incorrect exit behavior](https://github.com/MPh-py/MPh/issues/15). | ||
| * Fixes: Exit code was always 0, even when terminating with `sys.exit(2)`. | ||
| * Fixes: Exit code was 0, not 1, when exiting due to unhandled exception. | ||
|
|
||
| ## 0.8.1 | ||
| * Released on February 9, 2021. | ||
| * Applies fixes for macOS from [pull request #11](https://github.com/MPh-py/MPh/pull/11). | ||
| * macOS support has now actually been tested according to [issue #13](https://github.com/MPh-py/MPh/issues/13). | ||
|
|
||
| ## 0.8.0 | ||
| * Released on February 7, 2020. | ||
| * Adds support for Linux and macOS. | ||
| * Caveats apply. See documentation chapter ["Limitations"](https://mph.readthedocs.io/en/0.8/limitations.html) as well as issues [#8](https://github.com/MPh-py/MPh/issues/8) and [#9](https://github.com/MPh-py/MPh/issues/9). | ||
| * Refactored [discovery](https://mph.readthedocs.io/en/0.8/api/mph.discovery.html) mechanism for Comsol installations. | ||
|
|
||
| ## 0.7.6 | ||
| * Released on November 29, 2020. | ||
| * Unpins [JPype](https://pypi.org/project/JPype1) and Python version. | ||
| * Works around [issue #1](https://github.com/MPh-py/MPh/issues/1) by brute-forcing shutdown of Java VM. | ||
| * [`Client`](https://mph.readthedocs.io/en/0.7/api/mph.Client.html) instances now report the Comsol version actually used. | ||
| * Updates the documentation regarding [limitations](https://mph.readthedocs.io/en/0.7/limitations.html). | ||
| * Resolves [issue #4](https://github.com/MPh-py/MPh/issues/4) regarding compatibility with 32-bit Python. | ||
| * Possibly resolves [issue #5](https://github.com/MPh-py/MPh/issues/5) regarding spaces in path names. | ||
|
|
||
| ## 0.7.5 | ||
| * Released on July 30, 2020. | ||
| * First release used extensively "in production". | ||
| * Last release based on [JPype 0.7.5](https://github.com/jpype-project/jpype/releases/tag/v0.7.5). | ||
| * Performs a regular shutdown of the Java VM, as opposed to releases to follow. | ||
| * Respects user-set Comsol preferences when starting [`Client`](https://mph.readthedocs.io/en/0.7/api/mph.Client.html). | ||
| * Adds screen-shot of Comsol demonstration model to [Tutorial](https://mph.readthedocs.io/en/0.7/tutorial.html). | ||
| * Adds [deployment](https://github.com/MPh-py/MPh/tree/a86f77a7b26e24e314c01639b846a3ee927f1e6d/deploy) instructions for developers. | ||
|
|
||
| ## 0.7.4 | ||
| * Released on July 17, 2020. | ||
| * Pins JPype dependency to [version 0.7.5](https://github.com/jpype-project/jpype/releases/tag/v0.7.5). | ||
| * Works around shutdown delays of the Java VM, see [issue #1](https://github.com/MPh-py/MPh/issues/1). | ||
| * Requires Python version to be 3.8.3 or below. | ||
| * Minor improvements to wording of documentation. | ||
|
|
||
| ## 0.7.3 | ||
| * Released on June 15, 2020. | ||
| * Suppresses console pop-up during [client initialization](https://mph.readthedocs.io/en/0.7/api/mph.Client.html). | ||
| * Ignores empty units in [parameter assignments](https://mph.readthedocs.io/en/0.7/api/mph.Model.html#mph.Model.parameter). | ||
|
|
||
| ## 0.7.2 | ||
| * Released on May 18, 2020. | ||
| * Makes `dataset` argument to [`Model.outer()`](https://mph.readthedocs.io/en/0.7/api/mph.Model.html#mph.Model.outer) optional. | ||
| * Minor tweaks to project's meta information. | ||
|
|
||
| ## 0.7.1 | ||
| * Released on May 17, 2020… later that day. | ||
| * Fixes meta information [on PyPI](https://pypi.org/project/MPh). | ||
|
|
||
| ## 0.7.0 | ||
| * Released on May 17, 2020. | ||
| * First open-source release [published on PyPI](https://pypi.org/project/MPh#history). |