foamlib: A modern Python package for working with OpenFOAM

🌟 v1.3.0 Highlights

• Simplified API: The Dimensioned and DimensionSet classes are now (also) available at the top level.
• Better docs: Improved documentation, re-organized pages, fixed typos, and added more cross-references.
• [foamlib.preprocessing] Easier automation: You can now create parameter studies directly from Python.
• [foamlib.preprocessing][foamlib.postprocessing]: Better error messages: When attempting to import without the required extras dependencies.

What's Changed

• Improve error message when importing modules without extra dependencies by @gerlero in https://github.com/gerlero/foamlib/pull/500
• Update type hints by @gerlero in https://github.com/gerlero/foamlib/pull/503
• Improve typing by @gerlero in https://github.com/gerlero/foamlib/pull/504
• Update typing by @gerlero in https://github.com/gerlero/foamlib/pull/505
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/506
• Remove redundant onerror parameter in _rmtree by @gerlero in https://github.com/gerlero/foamlib/pull/507
• Update _cases._util module by @gerlero in https://github.com/gerlero/foamlib/pull/508
• Update type hints by @gerlero in https://github.com/gerlero/foamlib/pull/509
• Move is_sequence function to _util module by @gerlero in https://github.com/gerlero/foamlib/pull/511
• Rename type variables by @gerlero in https://github.com/gerlero/foamlib/pull/512
• Rename internal submodules by @gerlero in https://github.com/gerlero/foamlib/pull/513
• Update dependency groups by @gerlero in https://github.com/gerlero/foamlib/pull/515
• Update typing by @gerlero in https://github.com/gerlero/foamlib/pull/517
• Potential fix for code scanning alert no. 1: Workflow does not contain permissions by @gerlero in https://github.com/gerlero/foamlib/pull/518
• Potential fix for code scanning alert no. 2: Workflow does not contain permissions by @gerlero in https://github.com/gerlero/foamlib/pull/519
• Create parameter studies from records by @greole in https://github.com/gerlero/foamlib/pull/502
• Exposed Dimensioned and DimensionSet classes at the top level by @gerlero in https://github.com/gerlero/foamlib/pull/521
• Update documentation pages of extra modules by @gerlero in https://github.com/gerlero/foamlib/pull/501
• Switch preprocessing.system functions to PEP 8/FoamCase-like names by @gerlero in https://github.com/gerlero/foamlib/pull/510
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/523
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/524
• Update docs site by @gerlero in https://github.com/gerlero/foamlib/pull/525
• Update docs by @gerlero in https://github.com/gerlero/foamlib/pull/527
• Fix docstring typos, language issues, and add cross-references by @Copilot in https://github.com/gerlero/foamlib/pull/526
• Update docs by @gerlero in https://github.com/gerlero/foamlib/pull/528
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/529
• Fix dimensions type hint by @gerlero in https://github.com/gerlero/foamlib/pull/530
• Update .readthedocs.yaml by @gerlero in https://github.com/gerlero/foamlib/pull/531
• Clarify foamlib description and paper reference by @gerlero in https://github.com/gerlero/foamlib/pull/532
• Update docs by @gerlero in https://github.com/gerlero/foamlib/pull/533

New Contributors

• @greole made their first contribution in https://github.com/gerlero/foamlib/pull/502

Full Changelog: https://github.com/gerlero/foamlib/compare/v1.2.1...v1.3.0