diff --git a/docs/releases/index.md b/docs/releases/index.md index c61acc3ad5891af8debb952b9bf707eb6ccd5f68..832713085986eabb87a07c413b25c37b3d377d64 100644 --- a/docs/releases/index.md +++ b/docs/releases/index.md @@ -5,6 +5,7 @@ maxdepth: 3 --- 0.x (upcoming release) <ogstools-0.x> +0.6.0 <ogstools-0.6.0> 0.5.0 <ogstools-0.5.0> 0.4.0 <ogstools-0.4.0> 0.3.1 <ogstools-0.3.1> diff --git a/docs/releases/ogstools-0.6.0.md b/docs/releases/ogstools-0.6.0.md new file mode 100644 index 0000000000000000000000000000000000000000..88ffffe21c48b607f3d467c9df4a18f36d0a06c7 --- /dev/null +++ b/docs/releases/ogstools-0.6.0.md @@ -0,0 +1,51 @@ +# OGSTools 0.6.0 Release Notes (upcoming release) + +OGS version: 6.5.4 +Python: 3.10 - 3.13 + +## API breaking changes + +- meshseries.probe now squeezes the returned array: it seems more intuitive + to return a 1D array if no list of points is provided (just a single tuple) + +- meshseries.plot_time_slice has a new user interface - see the update example + or the API reference. The interpolate argument was removed, as it tempts you to + be used as a default (as it produces a nice image), but in doing so, can easily + lead to wrong conclusions as the interpolated image might differ significantly + from the raw data. + +- generalized meshseries.animate: it is now a free standing function + (plot.animate) and can take any plotting function - see the updated example or + the API reference + +## Features + +- MeshSeries can now be initialized with `from_data(meshes, timevalues)` +- MeshSeries now has an .items() iterator +- MeshSeries has now an .extend function to combine 2 MeshSeries (e.g. for simulation restart/continuation) +- plot.line now automatically sorts the data +- User can select format when saving animation (gif or mp4) +- variables.vector add BHE vector with support for slicing its components +- Variables now have methods to create Variables related to absolute error, relative error and analytical solution corresponding to the parent Variable +- Variable.transform now also works on MeshSeries +- plot.line now can also handle MeshSeries - this allows to draw an array of lines in one call (e.g. lines for each pt in the MeshSeries over time or lines for each timestep over a spatial coordinate) +- plot.contourf now only returns a figure if it wasn't given one as an argument +- improved axis labelling for shared axes (only the outer axes should get labelled now) +- new: meshseries.resample to interpolate the meshseries to new timevalues +- new: extract_probe to create a new meshseries consisting only of points and + probed data at these points +- OGS_BIN_PATH is read, this allows to specify a location of a custom OGS (ogs wheel not needed) +- Improved errors and warnings when system has multiple or no OGS on PATH +- ogstools.status(verbose=True) prints status of OGS installation + +## Infrastructure + +### Tests + +- Tests can be marked as system and tools + - system tests: Invoke running a simulation with OGS + - tools tests: Invoke calls to OGS binary tools and pybind11 functionality (in future) + +### Imports + +- When imports are actually implementation details they should be loaded within the calling function (delayed initialization). Applied to imports that rely on OGS installation. diff --git a/docs/releases/ogstools-0.x.md b/docs/releases/ogstools-0.x.md index b6fbd912160aae7dd0686066c69533c502a78c82..89756136e8f19d78f47c2e20992e1b15a83dcd10 100644 --- a/docs/releases/ogstools-0.x.md +++ b/docs/releases/ogstools-0.x.md @@ -8,19 +8,6 @@ This is not released yet! ## API breaking changes -- meshseries.probe now squeezes the returned array: it seems more intuitive - to return a 1D array if no list of points is provided (just a single tuple) - -- meshseries.plot_time_slice has a new user interface - see the update example - or the API reference. The interpolate argument was removed, as it tempts you to - be used as a default (as it produces a nice image), but in doing so, can easily - lead to wrong conclusions as the interpolated image might differ significantly - from the raw data. - -- generalized meshseries.animate: its now a free standing function - (plot.animate) and can take any plotting function - see the updated example or - the API reference - - mesh.read_shape (removed function, functionality is not covered anymore) ### Examples @@ -33,42 +20,12 @@ This is not released yet! ## Features -- MeshSeries can now be initialized with `from_data(meshes, timevalues)` -- MeshSeries now has an .items() iterator -- MeshSeries has now an .extend function to combine 2 MeshSeries (e.g. for simulation restart/continuation) -- plot.line now automatically sorts the data -- User can select format when saving animation (gif or mp4) -- variables.vector add BHE vector with support for slicing its components -- Variables now have methods to create Variables related to absolute error, relative error and analytical solution corresponding to the parent Variable -- Variable.transform now also works on MeshSeries -- plot.line now can also handle MeshSeries - this allows to draw an array of lines in one call (e.g. lines for each pt in the MeshSeries over time or lines for each timestep over a spatial coordinate) -- plot.contourf now only returns a figure if it wasn't given one as an argument -- improved axis labelling for shared axes (only the outer axes should get labelled now) -- new: meshseries.resample to interpolate the meshseries to new timevalues -- new: extract_probe to create a new meshseries consisting only of points and - probed data at these points -- OGS_BIN_PATH is read, this allows to specify a location of a custom OGS (ogs wheel not needed) -- Improved errors and warnings when system has multiple or no OGS on PATH -- ogstools.status(verbose=True) prints status of OGS installation -- ogstools.cli() return an object for access to OGS command line tools (e.g. vtkdiff via `cli().vtkdiff(...)`) -- Enable saving mesh to ASCII - ## Infrastructure ### Tests -- Tests can be marked as system and tools - - system tests: Involve running a simulation with OGS - - tools tests: Involve calls to OGS binary tools and pybind11 functionality (in future) - ### Imports -- When imports are actually implementation details they can be load within function called (delayed initialization) - Applied to imports that rely on OGS installation - -### Container - -- Container for FEFLOW 10.0 added - ## Maintainer TODOs ### next sub release