Release 0.17.1 by franzpoeschel · Pull Request #1880 · openPMD/openPMD-api

franzpoeschel · 2026-05-18T08:52:18Z

https://github.com/openPMD/openPMD-api/milestone/17

TODO

Remaining items from the milestone
Docs
toml11, maybe use recent master commit?

Which version am I running?

Python

import openpmd_api
print(openpmd_api.__version__)

C++

#include <openPMD/openPMD.hpp>
#include <iostream>

int main() {
    // query compile-time macros:
    std::cout << OPENPMDAPI_VERSION_MAJOR << "."
              << OPENPMDAPI_VERSION_MINOR << "."
              << OPENPMDAPI_VERSION_PATCH << std::endl;
    // there is also: OPENPMDAPI_VERSION_LABEL (e.g. "alpha")

    // or query the runtime API (since 0.12.0):
    std::cout << openPMD::getVersion() << std::endl;
    return 0;
}

CLI

# command line option (since 0.12.0):
openpmd-ls --version

* Bump Pybind11 to 3.0.2 * Use cpp_function for defining properties

This reverts commit 3f3063b.

* Bump versions for toml11 nlohmann_json pybind11 * Return py::object instead of std::variant to pybind11

…PMD#1851) * Fix keepalives * Add simple GC test * Add keepalive for snapshots api * Add more extensive keepalive test * Slightly API-breaking.. need to del everything * tmp, check sth * tmp check ci * Revert "tmp check ci" This reverts commit 1cf6973. * Revert "tmp, check sth" This reverts commit 93ed467. * Fix typing issues with load/store_chunk in Python

These are prefixed by test*, so they already run separately.

* CI: Fix AppVeyor x64 (64bit) build: Architecture not part of `-G` anymore, maybe `-A x64` * Fix instantiations for AttributeWithShapeAndResource * `PatchRecordComponent`: Match Identical Types * Consistency: `dtype_to_numpy` and `dtype_from_numpy` * Update: `APITest.py` `testDataset` Co-authored-by: Franz Pöschel <franz.poeschel@gmail.com>

* Fix typing issues with load/store_chunk in Python * Datatype helpers: non-template variants * Unify Datatype equality semantics * replace operator==(Datatype, Datatype) by isSame

Replicate a Golang-inspired defer pattern in order to ensure resource cleanup also upon early return. --------- Co-authored-by: AI Agent <ai@anthropic.com>

) * Fix sticky permissions * Use the helpers only privately

…D#1860) * attempt to fix issue openPMD#1859 by caching the index and avoid indexOf() call for iterations --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Franz Pöschel <franz.poeschel@gmail.com>

* Do not flush if the backend does not support Span API * Fix flushing logic

…1869)

This is an initial draft based on commits since v0.17.0. Categories and items may be adjusted before release.

…enPMD#1873) this avoids subtle bugs followup to openPMD#1860

test/Files_Core/read_nonexistent_attribute.cpp:23:10: fatal error: catch2/catch_to string.hpp: No such file or directory 23 | #include <catch2/catch_tostring.hpp> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~ compilation terminated.

* ADIOS2: enable stats by default, starting ADIOS2 v2.12.0 This PR ornladios/ADIOS2#4985 changes things a bit performance-wise.

* Update toml11 to current main tag b32a2fff0d27e1f7522f26a125101500ddb47156 * Define TOML11_DISABLE_SOURCE_LOCATION (up for discussion)

* Delete stray inc_ref * Reaquire the GIL for releasing references to Python buffers * Use std::optional for simplified explicit destruction * Make Iterator GIL free * Add this also for other flushing methods

* Migrate to Catch2 v3 Co-authored-by: Franz Pöschel <franz.poeschel@gmail.com>

…D#1878 openPMD#1823)

retrigger ci

The official spelling (homepage, recent papers) seems to use "Center for Advanced ..." spelling, not "of". Update accordingly :)

openPMD#1886)

Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v6...v7) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

The "MSVC w/o MPI via pip" job failed on the windows-latest runner after it upgraded to Visual Studio 2026 (VS 18): Generator NMake Makefiles does not support platform specification, but platform x64 was specified. CMAKE_C_COMPILER not set, after EnableLanguage `pip wheel` builds in an isolated environment that installs CMake per pyproject.toml's build requirement. The `<4.0.0` cap pinned that CMake to 3.x, which predates the "Visual Studio 18 2026" generator (added in CMake 4.2), so CMake fell back to "NMake Makefiles" and rejected setup.py's `-A x64`. Drop the CMake upper bound so the isolated build uses a current CMake that auto-detects the VS 2026 generator, matching the runner's own CMake that the non-pip MSVC job already builds with. Also bump the job to Python 3.11. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

The license metadata was replaced with a standard SPDX identifier.

ax3l

Looks great, I'll tag the release now.

franzpoeschel and others added 29 commits April 8, 2026 11:59

Version bump pybind11 -> 3.0.2 (openPMD#1849)

ec8251e

* Bump Pybind11 to 3.0.2 * Use cpp_function for defining properties

Revert pybind11 default version back to old

3f3063b

Revert "Revert pybind11 default version back to old"

159e155

This reverts commit 3f3063b.

Bump toml11 to 4.4.0, nlohmann_json to 3.12.0 (openPMD#1842)

4e6a6b4

* Bump versions for toml11 nlohmann_json pybind11 * Return py::object instead of std::variant to pybind11

Remove duplicate Python test (openPMD#1867)

4d2b90b

These are prefixed by test*, so they already run separately.

Harmonize Datatype equality checks (openPMD#1854)

2693185

* Fix typing issues with load/store_chunk in Python * Datatype helpers: non-template variants * Unify Datatype equality semantics * replace operator==(Datatype, Datatype) by isSame

HDF5: Close operations also upon failure (openPMD#1866)

190a2c4

Replicate a Golang-inspired defer pattern in order to ensure resource cleanup also upon early return. --------- Co-authored-by: AI Agent <ai@anthropic.com>

HDF5: proper status check (openPMD#1870)

ff38bc6

Fix parallel deletion (openPMD#1858)

12f19e5

create_directories: preserve sticky and setgid permissions (openPMD#1855

3d6062c

) * Fix sticky permissions * Use the helpers only privately

Do not flush if the backend does not support Span API (openPMD#1863)

98f68e3

* Do not flush if the backend does not support Span API * Fix flushing logic

Flush dirty ADIOS2 files in sorted order (openPMD#1868)

ddd2e84

Keep written flag consistent across MPI ranks for rankTable (openPMD#…

a828ca0

…1869)

WIP: First draft of CHANGELOG for 0.17.1

d1fbc78

This is an initial draft based on commits since v0.17.0. Categories and items may be adjusted before release.

Do not initially emplace any value for the cached Iteration index (op…

73cb37d

…enPMD#1873) this avoids subtle bugs followup to openPMD#1860

Update changelog

7460f46

Fix defer::to_opaque (openPMD#1872)

4abfa0f

Remove catch2/catch_tostring.hpp include (openPMD#1875)

c21ed88

test/Files_Core/read_nonexistent_attribute.cpp:23:10: fatal error: catch2/catch_to string.hpp: No such file or directory 23 | #include <catch2/catch_tostring.hpp> | ^~~~~~~~~~~~~~~~~~~~~~~~~~~ compilation terminated.

ADIOS2: enable stats by default, starting ADIOS2 v2.12.1 (openPMD#1877)

c13aeb1

* ADIOS2: enable stats by default, starting ADIOS2 v2.12.0 This PR ornladios/ADIOS2#4985 changes things a bit performance-wise.

Use most recent main branch of toml11 (openPMD#1874)

843a505

* Update toml11 to current main tag b32a2fff0d27e1f7522f26a125101500ddb47156 * Define TOML11_DISABLE_SOURCE_LOCATION (up for discussion)

Python: reacquire GIL for deallocation operations (openPMD#1878)

14f1425

* Delete stray inc_ref * Reaquire the GIL for releasing references to Python buffers * Use std::optional for simplified explicit destruction * Make Iterator GIL free * Add this also for other flushing methods

Migrate C++ Tests to Catch2 v3 (openPMD#1823)

57fccaf

* Migrate to Catch2 v3 Co-authored-by: Franz Pöschel <franz.poeschel@gmail.com>

Update CHANGELOG: add missing backported commits (openPMD#1877 openPM…

2d1f7ab

…D#1878 openPMD#1823)

Delete stray inc_ref (openPMD#1879)

6eccfdf

Update changelog

5f91cf2

version -> 0.17.1

a8f666f

retrigger ci

franzpoeschel mentioned this pull request May 18, 2026

Patch release 0.17.1 #1871

Closed

ax3l added this to the 0.17.1 milestone May 26, 2026

ax3l mentioned this pull request May 26, 2026

CMake 4 on MacOS breaks compilation due to old compatibility requirement #1839

Closed

ax3l and others added 6 commits June 3, 2026 11:44

Doc: CASUS "for" (openPMD#1883)

5ed09ec

The official spelling (homepage, recent papers) seems to use "Center for Advanced ..." spelling, not "of". Update accordingly :)

Update changelog

72c6100

Forbid slashes in attribute and variable names (openPMD#1884)

d7d4c7d

Update changelog

1451f70

Fix contiguous check: Accept only C-contiguous, not Fortran contiguous (

b5e5f73

openPMD#1886)

Update changelog

996d1ff

ax3l mentioned this pull request Jun 22, 2026

Fix deprecated use in InvalidatableFile.hpp #1888

Merged

dependabot Bot and others added 5 commits June 22, 2026 16:23

Fix deprecated use in InvalidatableFile.hpp

0a7169d

setup.py: License SPDX

ef157a0

The license metadata was replaced with a standard SPDX identifier.

Changelog: Finalize

1675785

ax3l self-requested a review June 22, 2026 23:30

ax3l self-assigned this Jun 22, 2026

ax3l added the documentation label Jun 22, 2026

ax3l approved these changes Jun 22, 2026

View reviewed changes

cleanup: test version

84fb474

ax3l merged commit f0033b4 into openPMD:release-0.17.1 Jun 23, 2026
28 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release 0.17.1#1880

Release 0.17.1#1880
ax3l merged 41 commits into
openPMD:release-0.17.1from
franzpoeschel:release-0.17.1-wip

franzpoeschel commented May 18, 2026 •

edited by ax3l

Loading

Uh oh!

ax3l left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

franzpoeschel commented May 18, 2026 • edited by ax3l Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Which version am I running?

Python

C++

CLI

Uh oh!

ax3l left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

franzpoeschel commented May 18, 2026 •

edited by ax3l

Loading