v1.4.0

What's Changed

Added

• Support for Python 3.14 by @fschuch in #130

Removed

• Support for Python 3.9 by @fschuch in #130

Changed

• Patch maintainability issues by @fschuch in #101
• Relicense project from GPL-3.0 to MIT License by @fschuch in #129

Full Changelog: v1.3.3...v1.4.0

v1.3.3

Internals

• Apply project management changes and documentation enhancements from Wizard-template v0.3.1 by @fschuch in #98
• Bump the pip-dependencies group with 5 updates by @dependabot[bot] in #99

Full Changelog: v1.3.2...v1.3.3

v1.3.2

Fixed

• Resolved warnings from ipywidgets on gui.ParametersGui by @fschuch in #80

Full Changelog: v1.3.1...v1.3.2

v1.3.1

Added

• Support for Python 3.13 by @fschuch in #79

Fixed

• Internal ValueError from xarray on sandbox.init_dataset affecting Python 3.10, 3.11, and 3.12 by @fschuch in #78

Full Changelog: v1.3.0...v1.3.1

v1.3.0

Removed

• Dropped support for Python 3.8 by @fschuch in #73

Fixed

• Fixed Dataset.load_snapshot to use the specified number of scalar digits instead of just the last one by @fschuch in #75

Internals

• Bumped all dependencies in the project by @fschuch in #74

Full Changelog: v1.2.1...v1.3.0

v1.2.1

Added

• Added iforces parameter to ibmstuff by @fschuch in #65

Full Changelog: v1.2.0...v1.2.1

v1.2.0

Deprecated

• The integration methods cumtrapz and simps on xcompact3d_toolbox.array have been deprecated in favor of cumulative_trapezoid and simpson respectively, following the same changes applied upstream on SciPy 1.12.0

Added

• Added loguru to enhance logging in the project

Changed

• Dropped support for Python 3.7 and added support for Python 3.10, 3.11, and 3.12
• Boolean arguments in all functions and methods changed to keyword-only
• Changed all arguments on xcompact3d_toolbox.sandbox.Geometry to keyword-only
• Changed the project versioning schema to Intended Effort Versioning
• Function xcompact3d_toolbox.gene_epsi_3D was renamed to xcompact3d_toolbox.gene_epsi_3d

Fixed

• Corrected typos, typing annotating, and formatting issues in the codebase and documentation
• Fixed a bug on xcompact3d_toolbox.gui._divisor_generator affecting the coupling between p_row, p_col, and ncores on ParametersGui._observe_2decomp method
• Fixed bug on xcompact3d_toolbox.sandbox.Geometry.from_stl on some platforms that resolve np.longdouble to np.float128, which is not compatible with Numba
• Fixed compatibility issue on xcompact3d_toolbox.io.Dataset.load_snapshot when testing if field is_scalar on Python 3.8
• Fixed issue on xcompact3d_toolbox.sandbox.Geometry.square that was resulting in a TypeError because set object is not subscriptable

Documentation

• Replaced documentation framework by Jupyter Books to enhance interactive tutorials
• Migrated documentation hosting from readthedocs to GitHub Pages by @fschuch in #41
• Added a changelog page auto generated from GitHub release notes by @fschuch in #60

Internals

• Configured sonarcloud to power code quality analysis and coverage tracking on the project
• Modified the way of working on the project by applying the Wizard-Template by @fschuch in #14:
  • Hatch now manages Python installations, virtual environments, dependencies, maintenance scripts, and builds
  • mypy for static type checking
  • ruff as the linter and code formatter
  • codespell to check spelling
  • pytest as the test engine
  • Git hooks to guarantee consistency and leverage the aforementioned tools
  • GitHub workflows and dependabot were reviewed to address the previous points

Full Changelog: v1.1.1...v1.2.0

v1.1.1

Fixed

• Specified the version for netcdf4, to avoid a issues with the latest version (#13), by @fschuch.

Modified

• Support for parallel computing with dask was extended at genepsi.gene_epsi_3D, by @fschuch.

v1.1.0

Added

• Add sandbox.Geometry.from_stl. It reads an stl file and is able to compute what mesh points are inside or outside the geometry, so we can specify the geometry for a very customized immersed boundary method. By @fschuch and @nbeb.
• Add xcompact3d_toolbox.tutorial, making it easier to get datasets for documentation and tutorials, by @fschuch.
• Add xcompact3d_toolbox.Parameters.from_string, an useful method to get the parameters from the datasets at the tutorials, by @fschuch.
• Add tutorial Computing and Plotting, by @fschuch.
• Add tutorial Reading and writing files, by @fschuch.

Modified

• io.Dataset.data_path is now obtained automatically from parameters.Parameter.filename at initialization (i.g., if filename = "./example/input.i3d" then data_path = "./example/data/"). Of course, data_path can be changed to any value after that. By @fschuch.
• io.Dataset.load_wind_turbine_data now have a default location for file_pattern. Atributes were included for the coordinate time. By @fschuch.
• io.Dataset.set now accepts keyword arguments to send to io.FilenameProperties.set, for a more concise sintaxe. By @fschuch.
• The default return from xcompact3d.param.boundary_condition now takes in consideration if the domain is periodic or not, by @fschuch.

Fixed

• fix_bug at gene_epsi_3D was not working properly (#3), by @fschuch.
• xcompact3d.io.Dataset.load_array was not working for files that do not change in time, like ./data/geometry/epsilon.bin, by @fschuch.

v1.0.1

Modified

• Rename the default branch to main, by @fschuch.

Added

• Add load_wind_turbine_data that reads the files from the disc and wraps the data into a xarray.Dataset, by @fschuch.

Fixed

• Black version was not working properly at setup.py, by @fschuch.