v0.3.0
v0.3.0 Release Notes
What's Changed
The 0.3.0 release of PyDPF-Post 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
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 #208
- Add DataObject by @MaxJPRey in #210
- Add Simulation by @PProfizi in #225
- Add different Mechanical simulations by @PProfizi in #258
- Add StaticMechanicalSimulation results by @PProfizi in #261
- Add TransientMechanicalSimulation results by @PProfizi in #282
- Add ModalMechanicalSimulation results by @PProfizi in #289
- Add HarmonicMechanicalSimulation results by @PProfizi in #293
- Add DataFrame by @PProfizi in #296
- Create new examples and make small bug fixes by @cbellot000 in #300
- Fix DataFrame.iselect, update DataFrame.axes, Naming convention by @PProfizi in #304
- Update ReadMe and fix DataFrame.plot bug by @cbellot000 in #305
- Add DataFrame.array by @PProfizi in #306
- Fix select on both component and mesh entities by @PProfizi in #307
- Add an associated displacement workflow to a DataFrame by @PProfizi in #309
- Update doc home page by @cbellot000 in #311
- Fixes to DataFrame.select and DataFrame.plot when no data is returned by @PProfizi in #312
- Suggestions from comments by @PProfizi in #313
- Last improvements to documentation for 0.3.0 by @PProfizi in #316
Documentation
- FEAT: prepare project for multi-version documentation by @jorgepiloto in #205
- Update install commands by @PProfizi in #281
- Add typehint example by @GuillemBarroso in #169
Bug fixes
CI/CD
- Vale: accept "PyDPF-Core" by @PProfizi in #317
- Fix calls to doc deployment actions by @PProfizi in #318
- Fix doc deployment 2 by @PProfizi in #319
- Update to 232 CI, start using pydpf-core structure. by @PProfizi in #314
- Use flake8 from GitHub by @PProfizi in #194
- update requirements tests by @cbellot000 in #201
- CI: fix mother branch name by @jorgepiloto in #214
- Fix Style Check step by @PProfizi in #279
- FIX: doc artifacts location by @jorgepiloto in #215
- FIX: missing CNAME env var by @jorgepiloto in #216
- Force doc style check with Vale before building the doc by @PProfizi in #218
Maintenance
- Bump to 0.2.6dev0 by @PProfizi in #156
- Bump imageio from 2.21.1 to 2.22.0 by @dependabot in #158
- Bump pypandoc from 1.8.1 to 1.9 by @dependabot in #165
- Maint/gitignore by @GuillemBarroso in #166
- Update python badge image by @GuillemBarroso in #163
- add customised DPF templates by @GuillemBarroso in #167
- Improve TypeHints by @GuillemBarroso in #164
- Bump pytest-cov from 3.0.0 to 4.0.0 by @dependabot in #171
- Bump coverage from 6.4.4 to 6.5.0 by @dependabot in #172
- Bump ansys-sphinx-theme from 0.5.2 to 0.6.0 by @dependabot in #173
- Bump imageio from 2.22.0 to 2.22.1 by @dependabot in #174
- Bump to 0.2.6.dev0 by @PProfizi in #175
- Bump ansys-sphinx-theme from 0.6.0 to 0.6.1 by @dependabot in #177
- Bump actions/setup-python from 4.2.0 to 4.3.0 by @dependabot in #179
- Bump imageio from 2.22.1 to 2.22.2 by @dependabot in #181
- Bump all pydpf-actions to v2.2 by @PProfizi in #183
- Bump pytest from 7.1.3 to 7.2.0 by @dependabot in #185
- Bump pypandoc from 1.9 to 1.10 by @dependabot in #186
- Bump ansys-sphinx-theme from 0.6.1 to 0.7.0 by @dependabot in #184
- Bump wheel from 0.37.1 to 0.38.2 by @dependabot in #190
- Bump dsaltares/fetch-gh-release-asset from 1.0.0 to 1.1.0 by @dependabot in #188
- Bump sphinx from 5.1.1 to 5.3.0 by @dependabot in #182
- Bump wheel from 0.38.2 to 0.38.3 by @dependabot in #191
- Bump wheel from 0.38.3 to 0.38.4 by @dependabot in #192
- Bump sphinx-autodoc-typehints from 1.19.1 to 1.19.5 by @dependabot in #189
- Bump ansys-sphinx-theme from 0.7.0 to 0.7.1 by @dependabot in #193
- Bump pyansys/pydpf-actions from 2.2 to 2.3 by @dependabot in #196
- Bump pytest-rerunfailures from 10.2 to 10.3 by @dependabot in #198
- Bump ansys-sphinx-theme from 0.7.1 to 0.7.2 by @dependabot in #200
- Bump ansys-sphinx-theme from 0.7.2 to 0.7.4 by @dependabot in #202
- Bump actions/setup-python from 4.3.0 to 4.3.1 by @dependabot in #211
- Bump ansys-sphinx-theme from 0.7.4 to 0.8.0 by @dependabot in #212
- Bump actions/setup-python from 4.3.1 to 4.4.0 by @dependabot in #228
- Bump sphinx from 5.3.0 to 6.0.0 by @dependabot in #243
- Bump coverage from 6.5.0 to 7.0.1 by @dependabot in #231
- Bump coverage from 7.0.1 to 7.0.2 by @dependabot in #245
- Bump imageio from 2.22.2 to 2.23.0 by @dependabot in #222
- Bump sphinx-autodoc-typehints from 1.19.5 to 1.20.0 by @dependabot in #250
- Bump sphinx-autodoc-typehints from 1.20.0 to 1.20.1 by @dependabot in #252
- Bump sphinx from 6.0.0 to 6.1.2 by @dependabot in #253
- Bump imageio from 2.23.0 to 2.24.0 by @dependabot in #255
- Bump sphinx from 6.1.2 to 6.1.3 by @dependabot in #259
- Bump actions/setup-python from 4.4.0 to 4.5.0 by @dependabot in #264
- Bump pytest-rerunfailures from 10.3 to 11.0 by @dependabot in #262
- Bump pyansys/actions from 2 to 3 by @dependabot in #260
- Bump pytest from 7.2.0 to 7.2.1 by @dependabot in #265
- Bump imageio from 2.24.0 to 2.25.0 by @dependabot in #271
- Bump sphinx-autodoc-typehints from 1.20.1 to 1.21.7 by @dependabot in #269
- Bump coverage from 7.0.2 to 7.1.0 by @dependabot in #273
- Bump ansys-sphinx-theme from 0.8.0 to 0.8.1 by @dependabot in #270
- Bump ansys-sphinx-theme from 0.8.1 to 0.8.2 by @dependabot in #278
- Bump ansys-sphinx-theme from 0.8.2 to 0.9.5 by @dependabot in #299
- Bump imageio from 2.25.0 to 2.26.0 by @dependabot in #298
- Bump pyvista from 0.36.1 to 0.38.3 by @dependabot in #294
- Bump sphinx-autodoc-typehints from 1.21.7 to 1.22 by @dependabot in #276
- Bump coverage from 7.1.0 to 7.2.1 by @dependabot in #303
- Bump pyansys/actions from 3 to 4 by @dependabot in #297
New Contributors
- @GuillemBarroso made their first contribution in #163
Full Changelog: v0.2.5...v0.3.0