Skip to content

v1.0.0
Compare
Choose a tag to compare
@fschuch fschuch released this 14 Sep 23:35
v1.0.0
01e3641
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Xcompact3d-toolbox has evolved considerably in the last year. The pre-release version has been employed in CFD research projects, and the feedback from the users helped to improve its interfaces and functionalities. The integration between this Python package and the numerical solver XCompact3d was experimental, and many of the functionalities were only available in a forked repository for a test of concept (fschuch/Xcompact3d). These features are now part of the main repository XCompact3d (see PR #51). With this, Xcompact3d-toolbox is ready for its first stable release.

Added

  • Support for stretched mesh at the xdmf writer and automatized tests for it, by @fschuch.
  • A class to handle the binary filenames and their tests. Now all methods support different filenames, like the classic ux000, or the new ux-0000.bin, besides some combinations between them. By @fschuch.
  • Classes to handle the coordinates and their tests, so they can be moved out of the parameters class, by @fschuch.
  • New class for the 3D coordinate system, with useful methods and its testes, by @fschuch.
  • Add class Dataset to read the binary files from XCompact3d on-demand, it is possible to loop through the snapshots, select any of them or read the entire time-series for a given variable. It returns them in a proper xarray.Dataset, by @fschuch.
  • Sets of dependencies for extra functionalities, like docs, tests, and visu, by @fschuch.
  • More parameters are now covered in the Parameters class, by @fschuch.
  • Add type hints to many functions and class methods, for a better development experience using modern IDEs, by @fschuch.

Modified

  • Writing methods for the binary files were moved from the xarray accessors to the Dataset class, by @fschuch.
  • The new sandbox flow configuration is now set with itype = 12, following its addition the XCompact3d's main repository (see #51), by @fschuch.
  • The documentation was improved, by @fschuch.

Fixed

  • Not installing all dependencies with pip install, by @fschuch.
  • Suppressed warning from tqdm, by @fschuch.
  • The output format from gene_epsi_3D has changed, fixing some compatibility issues with XCompact3d as well (see #51), by @fschuch.
Assets 2
Loading