Release 1.2.0rc0 (#24)

* Prepared release 1.2.0rc0 --------- Co-authored-by: fschuch <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Felipe N. Schuch <[email protected]>
fschuch · Mar 22, 2024 · bbf5d07 · bbf5d07
1 parent 29a0840
commit bbf5d07
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 |         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| QA      | [![CI](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/fschuch/xcompact3d_toolbox/main.svg)](https://results.pre-commit.ci/latest/github/fschuch/xcompact3d_toolbox/main)[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)        |
+| QA      | [![CI](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/ci.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/fschuch/xcompact3d_toolbox/main.svg)](https://results.pre-commit.ci/latest/github/fschuch/xcompact3d_toolbox/main)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fschuch_xcompact3d_toolbox&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fschuch_xcompact3d_toolbox)        |
 | Docs    | [![Docs](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/fschuch/xcompact3d_toolbox/actions/workflows/docs.yaml)[![Documentation Status](https://readthedocs.org/projects/xcompact3d_toolbox/badge/?version=latest)](https://xcompact3d-toolbox.readthedocs.io/en/latest/?badge=latest)                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | Package | [![PyPI - Version](https://img.shields.io/pypi/v/xcompact3d-toolbox.svg?logo=pypi&label=PyPI)](https://pypi.org/project/xcompact3d-toolbox/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xcompact3d-toolbox.svg?logo=python&label=Python)](https://pypi.org/project/xcompact3d-toolbox/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | Meta    | [![Wizard Template](https://img.shields.io/badge/Wizard-Template-%23447CAA)](https://github.com/fschuch/wizard-template) [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![PyPI - License](https://img.shields.io/pypi/l/xcompact3d-toolbox?color=blue)](https://github.com/fschuch/xcompact3d_toolbox/blob/master/LICENSE) [![EffVer Versioning](https://img.shields.io/badge/version_scheme-EffVer-0097a7)](https://jacobtomlinson.dev/effver) |
@@ -26,7 +26,7 @@ For developers, it works as a rapid prototyping tool, to test concepts and then
 ## Useful links
 
 - [Documentation](https://xcompact3d-toolbox.readthedocs.io/);
-- [Changelog](https://github.com/fschuch/xcompact3d_toolbox/blob/master/CHANGELOG.md);
+- [Changelog](https://github.com/fschuch/xcompact3d_toolbox/blob/master/docs/news.md);
 - [Suggestions for new features and bug report](https://github.com/fschuch/xcompact3d_toolbox/issues);
 - [See what is coming next (Project page)](https://github.com/fschuch/xcompact3d_toolbox/projects/1);
 - [Xcompact3d's repository](https://github.com/xcompact3d/Incompact3d).

diff --git a/changelog.d/+1f5c6649.fixed.md b/changelog.d/+1f5c6649.fixed.md
diff --git a/changelog.d/+4517c34f.changed.md b/changelog.d/+4517c34f.changed.md
diff --git a/changelog.d/+548c549a.added.md b/changelog.d/+548c549a.added.md
diff --git a/changelog.d/+651a832a.changed.md b/changelog.d/+651a832a.changed.md
diff --git a/changelog.d/+659925a9.fixed.md b/changelog.d/+659925a9.fixed.md
diff --git a/changelog.d/+66ff54ce.fixed.md b/changelog.d/+66ff54ce.fixed.md
diff --git a/changelog.d/+80ff934b.changed.md b/changelog.d/+80ff934b.changed.md
diff --git a/changelog.d/+86de082c.added.md b/changelog.d/+86de082c.added.md
diff --git a/changelog.d/+a7c50061.added.md b/changelog.d/+a7c50061.added.md
diff --git a/changelog.d/+b768adc2.changed.md b/changelog.d/+b768adc2.changed.md
diff --git a/changelog.d/+b7e6f42f.changed.md b/changelog.d/+b7e6f42f.changed.md
diff --git a/changelog.d/+c71ded6a.fixed.md b/changelog.d/+c71ded6a.fixed.md
diff --git a/changelog.d/+c9f0a36f.fixed.md b/changelog.d/+c9f0a36f.fixed.md
diff --git a/changelog.d/+f2260584.docs.md b/changelog.d/+f2260584.docs.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,7 +27,6 @@ compare results to validate any future Fortran implementations.
 **Useful links**
 
 * `View on GitHub`_;
-* `Changelog`_;
 * `Suggestions for new features and bug report`_;
 * `See what is coming next (Project page)`_.
 
@@ -44,10 +43,6 @@ It is possible to install using pip::
 There are other dependency sets for extra functionality::
 
    pip install xcompact3d-toolbox[visu] # interactive visualization with hvplot and others
-   pip install xcompact3d-toolbox[doc]  # dependencies to build the documentation
-   pip install xcompact3d-toolbox[dev]  # tools for development
-   pip install xcompact3d-toolbox[test] # tools for testing
-   pip install xcompact3d-toolbox[all]  # all the above
 
 To install from source, clone de repository::
 
@@ -135,7 +130,6 @@ Examples
 .. image:: https://www.fschuch.com/en/slides/2021-x3d-dev-meeting/Output.gif
 
 .. _`View on GitHub`: https://github.com/fschuch/xcompact3d_toolbox
-.. _`Changelog`: https://github.com/fschuch/xcompact3d_toolbox/blob/master/CHANGELOG.md
 .. _`Suggestions for new features and bug report`: https://github.com/fschuch/xcompact3d_toolbox/issues
 .. _`See what is coming next (Project page)`: https://github.com/fschuch/xcompact3d_toolbox/projects/1
 

diff --git a/docs/news.md b/docs/news.md
@@ -1,18 +1,55 @@
 # What’s New
 
-<!-- markdown-link-check-disable -->
-
 All notable changes to this project will be documented in this page.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Intended Effort Versioning](https://jacobtomlinson.dev/effver/) (EffVer for short).
 The changes for the upcoming release can be found in [changelog.d](https://github.com/fschuch/xcompact3d_toolbox/tree/main/changelog.d/).
 
-<!-- markdown-link-check-enable -->
-
 <!-- WARNING: This file is auto-generated. Do not manually update this file. -->
 
 <!-- towncrier release notes start -->
 
+## [1.2.0rc0](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v1.2.0rc0) - 2024-03-21<!-- markdown-link-check-disable-line -->
+
+### Added
+
+- Added [loguru](https://loguru.readthedocs.io/en/stable/) to enhance logging in the project
+- Added support for Python 3.10, 3.11, and 3.12
+- Configured [sonarcloud](https://sonarcloud.io/project/overview?id=fschuch_xcompact3d_toolbox) to power code quality analysis and coverage tracking on the project
+
+### Changed
+
+- 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](https://jacobtomlinson.dev/effver/)
+
+- Function `xcompact3d_toolbox.gene_epsi_3D` was renamed to `xcompact3d_toolbox.gene_epsi_3d`
+
+- Modified the way of working on the project by applying the [Wizard-Template](https://github.com/fschuch/wizard-template):
+
+  - [Hatch](https://hatch.pypa.io) now manages Python installations, virtual environments, dependencies, maintenance scripts, and builds
+  - [mypy](https://mypy.readthedocs.io/en/stable/) for static type checking
+  - [ruff](https://github.com/astral-sh/ruff) as the linter and code formatter
+  - [codespell](https://github.com/codespell-project/codespell) to check spelling
+  - [pytest](https://docs.pytest.org/en/7.4.x/) as the test engine
+  - [towncrier](https://towncrier.readthedocs.io/en/stable/index.html) handles the changelog file
+  - [Git hooks](https://pre-commit.com/) to guarantee consistency and leverage the aforementioned tools
+  - GitHub workflows and dependabot were reviewed to address the previous points
+
+### 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](https://jupyterbook.org/en/stable/intro.html) to enhance interactive tutorials
+
 ## [1.1.1](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v1.1.1) - 2023-08-10
 
 ### Fixed

diff --git a/towncrier.toml b/towncrier.toml
@@ -3,8 +3,9 @@ package = "xcompact3d_toolbox"
 directory = "changelog.d"
 filename = "docs/news.md"
 start_string = "<!-- towncrier release notes start -->\n"
-title_format = "## [{version}](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v{version}) - {project_date}"
+title_format = "## [{version}](https://github.com/fschuch/xcompact3d_toolbox/releases/tag/v{version}) - {project_date}<!-- markdown-link-check-disable-line -->"
 issue_format = "[#{issue}](https://github.com/fschuch/xcompact3d_toolbox/issues/{issue})"
+underlines = ["", "", ""]
 
 [[tool.towncrier.type]]
 directory = "security"

diff --git a/xcompact3d_toolbox/_version.py b/xcompact3d_toolbox/_version.py
@@ -1,3 +1,3 @@
 """Version information for xcompact3d_toolbox package."""
 
-__version__ = "1.1.1"
+__version__ = "1.2.0rc0"