Skip to content

Conversation

@haykh
Copy link
Contributor

@haykh haykh commented Jul 16, 2025

This release is a full rewrite of nt2py.

Key changes

  1. Reading and handling of the data is now fully separated. Data class now relies on an external BaseReader class (which can be inferred automatically or passed manually).
  2. The BaseReader is a pure virtual class which is then implemented by different format-specific classes, e.g., hdf5.Reader and adios2.Reader. The Data class is completely agnostic to which reader is being used.
  3. BaseReader now does a much better job reading (or skipping) corrupted files, while building its internal structure regardless of how many files were skipped.
  4. Readers now use an explicit @dask.delayed decorator for lazy loading.
  5. Unit tests have been added with synthetic data in 2D/3D with both hdf5 and adios2 formats.

To-do for the release

  • support for the fields
  • support for the particle arrays (ragged np.nan paddings)
  • support for the spectra
  • command line app for quick plotting and movie making

Not-to-forget before the release

  • check all the README instructions
  • make sure unit tests cover most of the use cases

@haykh haykh self-assigned this Jul 16, 2025
@haykh haykh added the enhancement New feature or request label Jul 16, 2025
@haykh haykh merged commit 4fc4137 into master Sep 8, 2025
1 check passed
@haykh haykh deleted the 1.0.0rc branch September 8, 2025 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants