Version 0.8.2 Release

This patch release adds turbulence intensity values to the comparison.py example and adds new variables, such as the bottom friction and turbine turbulence model, to the CaseStudy class to control in the model templates.

What's Changed

• Add turbulence intensity values to model comparison example by @H0R5E in #44
• Update templates by @H0R5E in #45

Full Changelog: v0.8.1...v0.8.2

Version 0.8.1 Release

This release adds turbulence intensity outputs to the grid_convergence.py example. This includes convergence studies on the turbulence intensity in the free stream and the wake, and plotting and error checking of the turbulence intensity along the wake centreline for the different grid resolutions. Additionally, alongside some bug fixes, improvements have been made to the interpolation of the turbulent values from the edges to the faces grids, resulting in improved performance for the analysis over version 0.8.0.

What's Changed

• Add turbulence intensity outputs to grid convergence example by @H0R5E in #43

Full Changelog: v0.8.0...v0.8.1

Version 0.8.0 Release

This release adds examples of extracting turbulent quantities to the basic.py and validation.py examples. Other notable changes are that the k-indexed layers have been replaced by layers described by the sigma value, which provides consistency between the different layers used by the Edges and Faces classes. Also, Transect objects must now be initialized with integer ID value as their first argument.

What's Changed

• Add sigma values to Result structures and remove k-index by @H0R5E in #40
• Add turbulent kinetic energy to Faces and Edges outputs by @H0R5E in #41
• Add Turbulence to Basic and Validation examples by @H0R5E in #42

Full Changelog: v0.7.0...v0.8.0

Version 0.7.0 Release

This release adds Python 3.10 support and updates the dependency versions to a working set for both Python 3.9 and 3.10.

What's Changed

• Add Python 3.10 support by @H0R5E in #39

Full Changelog: v0.6.1...v0.7.0

Version 0.6.1 Patch Release

This release adds data for the 15% TI experiments from the Mycek et al (2014) paper. The grid convergence and comparison examples are updated to include this new data and the corresponding online docs have also been changed.

Additionally, a new method is_equal was added to the CaseStudy class to allow comparisons between CaseStudy objects where some fields can be ignored.

What's Changed

• Add 15% TI Mycek Data by @H0R5E in #38

Full Changelog: v0.6.0...v0.6.1

Version 0.6.0 Release

This release coincides with the new comparison example between the FM and structured grid models, called comparison.py. Additional updates are:

• CaseStudy classes can now be exported and imported to and from YAML files
• Labels can now be added to headings, tables and images in the Content class
• Examples can now share simulations that are stored for reuse.

What's Changed

• Add comparison between FM and structured models by @H0R5E in #37

Full Changelog: v0.5.3...v0.6.0

Version 0.5.3 Patch Release

This patch release coincides with adaptation of the convergence study example for structured grids. Additionally, setting the number of OMP threads for structured model runs is now removed, as this feature is not implemented in Delft3D.

What's Changed

• Add structured mesh grid convergence study example by @H0R5E in #36

Full Changelog: v0.5.2...v0.5.3

Version 0.5.2 Patch Release

This patch release fixes a bug where only structured grids with three layers could be read.

What's Changed

• Deploy docs on any push event on the main branch by @H0R5E in #33
• Add zipped example folder to release assets by @H0R5E in #34
• Read Trim files with arbitrary number of layers by @H0R5E in #35

Full Changelog: v0.5.1...v0.5.2

Version 0.5.1 Patch Release

This is a patch release to correct the structured template files not being included in the conda package (of version 0.5.0).

Version 0.5.0 Release

This release adds analysis of structured mesh models, executed using the SNL-Delft3D-CEC Delft3D-4 extension. Structured mesh model templates can now be created with the template.Template class by passing the string "structured" as the first argument. The runner module classes and the result.Result class will automatically detect the type of model to be run and analysed. See the basic_structured.py file in the examples folder for an example of a complete structured mesh run (note that a complied copy of SNL-Delft3D-CEC is required).

What's Changed

• Ignore build artefacts when pushing to gh-pages by @H0R5E in #25
• Docs Update by @H0R5E in #26
• Add structured grid file generation by @H0R5E in #27
• Add versioning to HTML documentation by @H0R5E in #28
• Add Structured Model Template by @H0R5E in #29
• Add automatic detection of model type in Runner classes by @H0R5E in #30
• Add structured model result analysis by @H0R5E in #31

Full Changelog: v0.4.3...v0.5.0