v0.3.0

[PProfizi]

v0.3.0 Release Notes

What's Changed

The 0.3.0 release of PyDPF-Core introduces a refactoring of the library.
The old API related to the Solution object is still present but marked as legacy,
while a new API based on the Simulation object is added and allows for
a flatter, user-friendly, and auto-completion friendly API.

Its goal is to offer specific methods and helpers, using the right vocabulary, depending on the
type on analysis and the results associated to the result files being post-processed.

Four of these simulation types are implemented in this first release:

• Static mechanical
• Transient mechanical
• Modal mechanical
• Harmonic mechanical

Other types of analyses and other physics which were available with PyDPF-Post can still be processed using the legacy API.
Support for more types of physics and analyses in planned.

The new API centers around the Simulation object, and exposes data with DataFrame objects.
This DataFrame object presents data in a more user-friendly way, resembling already existing data manipulation
Python libraries such as Pandas.

Enhancements

• Post refactoring by @PProfizi in Post refactoring #219

This PR contains all the work related to the new PyDPF-Post API, with PRs:

• Post refactor - First PR: Add Selection, TimeFreqSelection, SpatialSelection with selection.py by @cbellot000, Add DataObject with data_object.py by @MaxJPRey, Add Mesh with mesh.py by @PProfizi, Add tools.select with tools.py by @cbellot000, with @GuillemBarroso, by @germa89 in Post refactor - First PR #208
• Add DataObject by @MaxJPRey in Add DataObject. #210
• Add Simulation by @PProfizi in Add Simulation #225
• Add different Mechanical simulations by @PProfizi in Add different Mechanical simulations #258
• Add StaticMechanicalSimulation results by @PProfizi in Implement StaticMechanicalSimulation results #261
• Add TransientMechanicalSimulation results by @PProfizi in Implement TransientMechanicalSimulation results #282
• Add ModalMechanicalSimulation results by @PProfizi in Implement ModalMechanicalSimulation results #289
• Add HarmonicMechanicalSimulation results by @PProfizi in Implement HarmonicMechanicalSimulation results #293
• Add DataFrame by @PProfizi in Post refactor dataframe #296
• Create new examples and make small bug fixes by @cbellot000 in Create examples for pydpf-post and make small bug fixes #300
• Fix DataFrame.iselect, update DataFrame.axes, Naming convention by @PProfizi in Fix iselect, update DataFrame.axes, Naming convention #304
• Update ReadMe and fix DataFrame.plot bug by @cbellot000 in update Read me and fix plot bug #305
• Add DataFrame.array by @PProfizi in Add Dataframe.array #306
• Fix select on both component and mesh entities by @PProfizi in Fix select on both component and mesh entities #307
• Add an associated displacement workflow to a DataFrame by @PProfizi in Add an associated displacement workflow to a DataFrame #309
• Update doc home page by @cbellot000 in Update doc home page #311
• Fixes to DataFrame.select and DataFrame.plot when no data is returned by @PProfizi in Fixes to select and plot when no data is returned #312
• Suggestions from comments by @PProfizi in Suggestions from comments #313
• Last improvements to documentation for 0.3.0 by @PProfizi in Last improvements to documentation for 0.3.0 #316

Documentation

• FEAT: prepare project for multi-version documentation by @jorgepiloto in FEAT: prepare project for multi-version documentation #205
• Update install commands by @PProfizi in Update install commands #281
• Add typehint example by @GuillemBarroso in MAINT: add typehint example #169

Bug fixes

CI/CD

• Vale: accept "PyDPF-Core" by @PProfizi in Vale: accept "PyDPF-Core" #317
• Fix calls to doc deployment actions by @PProfizi in Fix calls to doc deployment actions #318
• Fix doc deployment 2 by @PProfizi in Fix doc deployment 2 #319
• Update to 232 CI, start using pydpf-core structure. by @PProfizi in Update to 232 CI, start using pydpf-core structure. #314
• Use flake8 from GitHub by @PProfizi in Use flake8 from GitHub #194
• update requirements tests by @cbellot000 in update requirements tests #201
• CI: fix mother branch name by @jorgepiloto in CI: fix mother branch name #214
• Fix Style Check step by @PProfizi in Fix Style Check step #279
• FIX: doc artifacts location by @jorgepiloto in FIX: doc artifacts location #215
• FIX: missing CNAME env var by @jorgepiloto in FIX: missing CNAME env var #216
• Force doc style check with Vale before building the doc by @PProfizi in Force doc style check with Vale before building the doc #218

Maintenance

• Bump to 0.2.6dev0 by @PProfizi in Bump to 0.2.6dev0 #156
• Bump imageio from 2.21.1 to 2.22.0 by @dependabot in Bump imageio from 2.21.1 to 2.22.0 #158
• Bump pypandoc from 1.8.1 to 1.9 by @dependabot in Bump pypandoc from 1.8.1 to 1.9 #165
• Maint/gitignore by @GuillemBarroso in Maint/gitignore #166
• Update python badge image by @GuillemBarroso in Update python badge image #163
• add customised DPF templates by @GuillemBarroso in add customised DPF templates #167
• Improve TypeHints by @GuillemBarroso in Improve TypeHints #164
• Bump pytest-cov from 3.0.0 to 4.0.0 by @dependabot in Bump pytest-cov from 3.0.0 to 4.0.0 #171
• Bump coverage from 6.4.4 to 6.5.0 by @dependabot in Bump coverage from 6.4.4 to 6.5.0 #172
• Bump ansys-sphinx-theme from 0.5.2 to 0.6.0 by @dependabot in Bump ansys-sphinx-theme from 0.5.2 to 0.6.0 #173
• Bump imageio from 2.22.0 to 2.22.1 by @dependabot in Bump imageio from 2.22.0 to 2.22.1 #174
• Bump to 0.2.6.dev0 by @PProfizi in Bump to 0.2.6.dev0 #175
• Bump ansys-sphinx-theme from 0.6.0 to 0.6.1 by @dependabot in Bump ansys-sphinx-theme from 0.6.0 to 0.6.1 #177
• Bump actions/setup-python from 4.2.0 to 4.3.0 by @dependabot in Bump actions/setup-python from 4.2.0 to 4.3.0 #179
• Bump imageio from 2.22.1 to 2.22.2 by @dependabot in Bump imageio from 2.22.1 to 2.22.2 #181
• Bump all pydpf-actions to v2.2 by @PProfizi in Bump all pydpf-actions to v2.2 #183
• Bump pytest from 7.1.3 to 7.2.0 by @dependabot in Bump pytest from 7.1.3 to 7.2.0 #185
• Bump pypandoc from 1.9 to 1.10 by @dependabot in Bump pypandoc from 1.9 to 1.10 #186
• Bump ansys-sphinx-theme from 0.6.1 to 0.7.0 by @dependabot in Bump ansys-sphinx-theme from 0.6.1 to 0.7.0 #184
• Bump wheel from 0.37.1 to 0.38.2 by @dependabot in Bump wheel from 0.37.1 to 0.38.2 #190
• Bump dsaltares/fetch-gh-release-asset from 1.0.0 to 1.1.0 by @dependabot in Bump dsaltares/fetch-gh-release-asset from 1.0.0 to 1.1.0 #188
• Bump sphinx from 5.1.1 to 5.3.0 by @dependabot in Bump sphinx from 5.1.1 to 5.3.0 #182
• Bump wheel from 0.38.2 to 0.38.3 by @dependabot in Bump wheel from 0.38.2 to 0.38.3 #191
• Bump wheel from 0.38.3 to 0.38.4 by @dependabot in Bump wheel from 0.38.3 to 0.38.4 #192
• Bump sphinx-autodoc-typehints from 1.19.1 to 1.19.5 by @dependabot in Bump sphinx-autodoc-typehints from 1.19.1 to 1.19.5 #189
• Bump ansys-sphinx-theme from 0.7.0 to 0.7.1 by @dependabot in Bump ansys-sphinx-theme from 0.7.0 to 0.7.1 #193
• Bump pyansys/pydpf-actions from 2.2 to 2.3 by @dependabot in Bump pyansys/pydpf-actions from 2.2 to 2.3 #196
• Bump pytest-rerunfailures from 10.2 to 10.3 by @dependabot in Bump pytest-rerunfailures from 10.2 to 10.3 #198
• Bump ansys-sphinx-theme from 0.7.1 to 0.7.2 by @dependabot in Bump ansys-sphinx-theme from 0.7.1 to 0.7.2 #200
• Bump ansys-sphinx-theme from 0.7.2 to 0.7.4 by @dependabot in Bump ansys-sphinx-theme from 0.7.2 to 0.7.4 #202
• Bump actions/setup-python from 4.3.0 to 4.3.1 by @dependabot in Bump actions/setup-python from 4.3.0 to 4.3.1 #211
• Bump ansys-sphinx-theme from 0.7.4 to 0.8.0 by @dependabot in Bump ansys-sphinx-theme from 0.7.4 to 0.8.0 #212
• Bump actions/setup-python from 4.3.1 to 4.4.0 by @dependabot in Bump actions/setup-python from 4.3.1 to 4.4.0 #228
• Bump sphinx from 5.3.0 to 6.0.0 by @dependabot in Bump sphinx from 5.3.0 to 6.0.0 #243
• Bump coverage from 6.5.0 to 7.0.1 by @dependabot in Bump coverage from 6.5.0 to 7.0.1 #231
• Bump coverage from 7.0.1 to 7.0.2 by @dependabot in Bump coverage from 7.0.1 to 7.0.2 #245
• Bump imageio from 2.22.2 to 2.23.0 by @dependabot in Bump imageio from 2.22.2 to 2.23.0 #222
• Bump sphinx-autodoc-typehints from 1.19.5 to 1.20.0 by @dependabot in Bump sphinx-autodoc-typehints from 1.19.5 to 1.20.0 #250
• Bump sphinx-autodoc-typehints from 1.20.0 to 1.20.1 by @dependabot in Bump sphinx-autodoc-typehints from 1.20.0 to 1.20.1 #252
• Bump sphinx from 6.0.0 to 6.1.2 by @dependabot in Bump sphinx from 6.0.0 to 6.1.2 #253
• Bump imageio from 2.23.0 to 2.24.0 by @dependabot in Bump imageio from 2.23.0 to 2.24.0 #255
• Bump sphinx from 6.1.2 to 6.1.3 by @dependabot in Bump sphinx from 6.1.2 to 6.1.3 #259
• Bump actions/setup-python from 4.4.0 to 4.5.0 by @dependabot in Bump actions/setup-python from 4.4.0 to 4.5.0 #264
• Bump pytest-rerunfailures from 10.3 to 11.0 by @dependabot in Bump pytest-rerunfailures from 10.3 to 11.0 #262
• Bump pyansys/actions from 2 to 3 by @dependabot in Bump pyansys/actions from 2 to 3 #260
• Bump pytest from 7.2.0 to 7.2.1 by @dependabot in Bump pytest from 7.2.0 to 7.2.1 #265
• Bump imageio from 2.24.0 to 2.25.0 by @dependabot in Bump imageio from 2.24.0 to 2.25.0 #271
• Bump sphinx-autodoc-typehints from 1.20.1 to 1.21.7 by @dependabot in Bump sphinx-autodoc-typehints from 1.20.1 to 1.21.7 #269
• Bump coverage from 7.0.2 to 7.1.0 by @dependabot in Bump coverage from 7.0.2 to 7.1.0 #273
• Bump ansys-sphinx-theme from 0.8.0 to 0.8.1 by @dependabot in Bump ansys-sphinx-theme from 0.8.0 to 0.8.1 #270
• Bump ansys-sphinx-theme from 0.8.1 to 0.8.2 by @dependabot in Bump ansys-sphinx-theme from 0.8.1 to 0.8.2 #278
• Bump ansys-sphinx-theme from 0.8.2 to 0.9.5 by @dependabot in Bump ansys-sphinx-theme from 0.8.2 to 0.9.5 #299
• Bump imageio from 2.25.0 to 2.26.0 by @dependabot in Bump imageio from 2.25.0 to 2.26.0 #298
• Bump pyvista from 0.36.1 to 0.38.3 by @dependabot in Bump pyvista from 0.36.1 to 0.38.3 #294
• Bump sphinx-autodoc-typehints from 1.21.7 to 1.22 by @dependabot in Bump sphinx-autodoc-typehints from 1.21.7 to 1.22 #276
• Bump coverage from 7.1.0 to 7.2.1 by @dependabot in Bump coverage from 7.1.0 to 7.2.1 #303
• Bump pyansys/actions from 3 to 4 by @dependabot in Bump pyansys/actions from 3 to 4 #297

New Contributors

• @GuillemBarroso made their first contribution in Update python badge image #163

Full Changelog: v0.2.5...v0.3.0

---

This discussion was created from the release v0.3.0.