capytaine 2.3.1__tar.gz → 3.0.0a1__tar.gz

{capytaine-2.3.1 → capytaine-3.0.0a1}/.github/workflows/build_docs.yml

@@ -2,8 +2,6 @@ name: Build and deploy documentation
 
 on:
   push:
-    branches:
-      - master
     paths:
       - 'docs/**'
 
@@ -44,14 +42,13 @@ jobs:
 
       - name: Deploy pages
         if: |
-          github.repository_owner == 'capytaine' &&
-          github.ref == 'refs/heads/master'
-        # Only deploy the version merged into the master branch of capytaine/capytaine
+          github.repository_owner == 'capytaine'
+        # Only deploy the version of capytaine/capytaine
         uses: JamesIves/github-pages-deploy-action@releases/v4
         with:
           folder: ./docs/_build/html/
           repository-name: capytaine/capytaine.github.io
           branch: main
-          target-folder: master/
+          target-folder: ${{ github.ref_name }}/
           clean: true
           token: ${{ secrets.TOKEN_PAGES }}

{capytaine-2.3.1 → capytaine-3.0.0a1}/.github/workflows/build_wheels.yaml

@@ -15,7 +15,7 @@ jobs:
     runs-on: windows-2025
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - uses: fortran-lang/setup-fortran@v1
         with:
@@ -23,7 +23,7 @@ jobs:
           version: '13'
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v3.2.0
+        uses: pypa/cibuildwheel@v3.3.0
         env:
           CIBW_SKIP: "*win32* cp314t*"
           CIBW_BEFORE_BUILD_WINDOWS: pip install delvewheel
@@ -31,7 +31,7 @@ jobs:
           # Package the DLL dependencies in the wheel for windows (done by default for the other platforms).
           # delvewheel cannot mangle the libraries, stripping does not work.
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-windows
           path: ./wheelhouse/*.whl
@@ -41,19 +41,17 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
-      - uses: fortran-lang/setup-fortran@v1
-        with:
-          compiler: 'gcc'
-          version: '13'
+      # No need to setup fortran, it won't be used by CIbuildwheel which is
+      # using a Manylinux container
 
       - name: Build wheels on Ubuntu
-        uses: pypa/cibuildwheel@v3.2.0
+        uses: pypa/cibuildwheel@v3.3.0
         env:
           CIBW_SKIP: "*i686* *musllinux*"
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-ubuntu
           path: ./wheelhouse/*.whl
@@ -61,12 +59,10 @@ jobs:
 
   "build_wheels_on_macos_intel":
     name: Build wheels on MacOS Intel
-    runs-on: macos-13
-    # Should be replaced by macos-15-intel soon, but it does not seem to be
-    # supported by setup-fortran?
+    runs-on: macos-15-intel
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - uses: fortran-lang/setup-fortran@v1
         with:
@@ -74,11 +70,11 @@ jobs:
           version: '13'
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v3.2.0
+        uses: pypa/cibuildwheel@v3.3.0
         env:
-          CIBW_ENVIRONMENT: MACOSX_DEPLOYMENT_TARGET=13.0
+          CIBW_ENVIRONMENT: MACOSX_DEPLOYMENT_TARGET=15.0
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-macos-intel
           path: ./wheelhouse/*.whl
@@ -89,7 +85,7 @@ jobs:
     runs-on: macos-14
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - uses: fortran-lang/setup-fortran@v1
         with:
@@ -97,11 +93,11 @@ jobs:
           version: '13'
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v3.2.0
+        uses: pypa/cibuildwheel@v3.3.0
         env:
           CIBW_ENVIRONMENT: MACOSX_DEPLOYMENT_TARGET=14.0
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v6
         with:
           name: wheels-macos-arm
           path: ./wheelhouse/*.whl

{capytaine-2.3.1 → capytaine-3.0.0a1}/.github/workflows/test_new_commits.yaml

@@ -30,7 +30,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['38', '312']
+        python-version: ['38', '313']
 
     steps:
 
@@ -72,11 +72,11 @@ jobs:
     #     version: '13'
 
     - name: Compile and run example
-      working-directory: src/capytaine/green_functions/libDelhommeau/
+      working-directory: libs/libDelhommeau/
       run: make example && examples/minimal/minimal_example.bin
       # Soundness of the results is not tested, only that the compiling and
       # execution are succeeding.
 
     - name: Run simple benchmark
-      working-directory: src/capytaine/green_functions/libDelhommeau/
+      working-directory: libs/libDelhommeau/
       run: make run_bench_rankine && make run_bench_waves

capytaine-3.0.0a1/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+exclude: "pytest/.*/.*"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
+    hooks:
+      - id: check-added-large-files  # Prevent giant files from being committed
+      - id: check-ast  # Simply check whether files parse as valid python
+      - id: check-case-conflict  # Check for filenames that would conflict on a case-insensitive filesystem
+      - id: check-illegal-windows-names  # Check for filenames that could not exist on Windows
+      - id: check-merge-conflict  # Check for files that contain merge conflict strings
+      - id: check-symlinks  # Checks for symlinks which do not point to anything
+      - id: check-toml  # Attempts to load all TOML files to verify syntax
+      - id: check-yaml  # Attempts to load all YAML files to verify syntax
+      - id: debug-statements  # Check for calls to breakpoint()
+      - id: end-of-file-fixer  # Makes sure files end in a newline and only a newline
+      - id: no-commit-to-branch  # Disallow commiting directly to "master"
+      - id: mixed-line-ending  # Check the kind of line ending (LF or CRLF)
+      - id: trailing-whitespace  # Trim trailing whitespaces
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.4.1"
+    hooks:
+      - id: codespell
+        additional_dependencies:
+        - tomli

{capytaine-2.3.1 → capytaine-3.0.0a1}/Justfile

@@ -4,12 +4,14 @@ set windows-shell := ["powershell.exe", "-c"]
 default:
     just --list
 
+# Run the recipe below in a clean virtual environment to install Capytaine in
+# editable mode.
 editable_install:
     uv pip install -r pyproject.toml \
+        --extra optional \
         --group editable_install \
         --group dev
-    pip install --no-build-isolation --editable .
-    # Meson-backed editable install is not (yet?) supported by uv (https://github.com/astral-sh/uv/issues/10214)
+    uv pip install --no-build-isolation --editable .
 
 # Define the temporary directory differently based on OS
 TEMP_DIR := if os_family() == 'windows' {
@@ -25,13 +27,14 @@ NEMOH_CASES := TEST_DIR / 'Nemoh_verification_cases' / 'Cylinder'
 
 EXAMPLES_DIR := justfile_directory() / 'docs' / 'examples' / 'src'
 EXAMPLES_FILES := ' \
-    A1_radiation_cylinder.py \
+    A1_single_body_hydrodynamics.py \
     A2_multibody.py \
-    A3_finite_depth_cylinder.py \
-    A4_custom_dofs.py \
-    A5_convergence_study.py \
-    A7_elasticity_of_beam.py \
-    A8_export_dataset.py \
+    A3_finite_depth_flap.py \
+    A4_forward_speed_on_vertical_cylinder.py \
+    A7_custom_dofs.py \
+    A8_convergence_study.py \
+    A10_elasticity_of_beam.py \
+    A11_parametric_study_depth.py \
     B1_pressure_on_hull.py \
     B2_haskind.py \
     B3_free_surface_elevation.py \
@@ -44,14 +47,16 @@ EXAMPLES_FILES := ' \
 '
 
 ## Reason for skipping some example files:
-# A6_irregular_frequency_removal.py \     # Slow
+# A5_benchmark_plane_symmetries.py \
+# A6_benchmark_axisymmetric_mesh.py \
+# A9_test_irregular_frequency_removal.py \ # Slow
 # B6_animate_free_surface.py  \           # Requires VTK
 # B7_boat_animation.py  \                 # Requires VTK
 # C6_axisymmetric_buoy.py  \              # Requires VTK
-# C7_h_matrices_with_preconditionner.py \ # Slow
 # C10_custom_linear_solver_on_gpu.py \    # Requires torch
 
-# Run the test suite and the example files assuming a virtual environment has been activated
+# Run the test suite and the example files assuming a virtual environment with
+# Capytaine installed has been activated
 [unix]
 _test:
     #!/usr/bin/env bash
@@ -81,52 +86,81 @@ _test:
     capytaine {{NEMOH_CASES}}/Nemoh.cal
     capytaine {{NEMOH_CASES}}/Nemoh_v3.cal
 
+_install_and_test:
+    uv pip install --no-deps --no-build-isolation .
+    just _test
+
+
+# In the recipes below, we have
+#
+#    --no-editable --with "capytaine @ ." -- just _test
+#
+# or
+#
+#    --no-editable -- just _install_and_test
+#
+# because the default behavior of uv is to install the local project in
+# editable mode, but we don't want that because of an incompatibility with
+# meson-python (https://github.com/astral-sh/uv/issues/10214)
+#
+# besides, we have --no-default-groups because uv loads by default the `dev`
+# dependency-group from pyproject.toml, but we don't need it here and it can
+# actually cause issue in CI.
 
 test_in_latest_env:
     uv run \
-        --isolated --no-editable \
-        --only-group test \
+        --isolated --no-default-groups \
+        --no-editable --with "capytaine[optional] @ ." \
+        --group test \
+        -- \
         just _test
 
-test_in_py38_reference_env:
+# In the recipe below,
+# "--index-strategy unsafe-best-match" means uv should not ignore wheels
+# from PyPI during universal resolution
+
+test_in_nightly_env:
     uv run \
-        --isolated --no-editable \
-        --only-group test \
-        --python 3.8 \
-        --with-requirements {{TEST_DIR}}/envs/2023-08-01-py3.8.txt \
+        --isolated --no-default-groups \
+        --python 3.14 \
+        --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
+        --index-strategy unsafe-best-match \
+        --no-editable --with "capytaine @ ." \
+        --group test \
+        -- \
         just _test
-    # TODO: Also build Capytaine in this environment?
 
-test_in_py312_reference_env:
+
+test_in_py38_reference_env:
     uv run \
-        --isolated --no-editable \
-        --only-group test \
-        --python 3.12 \
-        --with-requirements {{TEST_DIR}}/envs/2025-04-18-py3.12.txt \
-        just _test
-    # TODO: Also build Capytaine in this environment?
+        --isolated --no-default-groups \
+        --python 3.8 \
+        --no-editable \
+        --with-requirements {{TEST_DIR}}/envs/2023-08-01-py3.8.txt \
+        -- \
+        just _install_and_test
 
-test_in_nightly_env:
+test_in_py313_reference_env:
     uv run \
-        --isolated --no-editable \
-        --pre --extra-index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
-        --index-strategy unsafe-best-match \
+        --isolated --no-default-groups \
         --python 3.13 \
-        --only-group test \
-        just _test
-    # "--index-strategy unsafe-best-match" means uv should not ignore wheels
-    # from PyPI during universal resolution
-    # TODO: Also build Capytaine in this environment?
+        --no-editable \
+        --with-requirements {{TEST_DIR}}/envs/2025-11-25-py3.13.txt \
+        -- \
+        just _install_and_test
 
 # How the requirements files from the above recipes where generated.
 create_test_env_file python="3.8" date="2023-08-01":
     uv pip compile \
-        pyproject.toml editable_install_requirements.txt \
+        pyproject.toml \
         --python-version {{python}} \
+        --group test \
+        --group editable_install \
+        --extra optional \
         --exclude-newer {{date}} \
-        --extra optional --extra test \
         -o {{TEST_DIR}}/envs/{{date}}-py{{python}}.txt
 
+
 # Compile the Fortran code without parallelism for easier reading of the errors.
 test_fortran_compilation:
     # It is assumed that meson and ninja are already installed (e.g. with editable_install).
@@ -135,8 +169,9 @@ test_fortran_compilation:
 
 build_docs:
     uv run \
-        --isolated --no-editable \
-        --only-group docs \
+        --isolated \
+        --no-editable --with "capytaine[optional] @ ." \
+        --group docs \
         -- \
         make --directory="./docs/"
 

{capytaine-2.3.1 → capytaine-3.0.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: capytaine
-Version: 2.3.1
+Version: 3.0.0a1
 Summary: Python BEM solver for linear potential flow, based on Nemoh
 Author-Email: Matthieu Ancellin <matthieu.ancellin@mews-labs.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -694,10 +694,15 @@ Requires-Dist: xarray
 Requires-Dist: rich
 Provides-Extra: optional
 Requires-Dist: matplotlib; extra == "optional"
+Requires-Dist: vtk; extra == "optional"
+Requires-Dist: pyvista; extra == "optional"
+Requires-Dist: psutil; extra == "optional"
 Requires-Dist: joblib>=1.3; extra == "optional"
+Requires-Dist: threadpoolctl; extra == "optional"
 Requires-Dist: meshio; extra == "optional"
+Requires-Dist: trimesh; extra == "optional"
+Requires-Dist: h5py; extra == "optional"
 Requires-Dist: netcdf4; extra == "optional"
-Requires-Dist: vtk; extra == "optional"
 Description-Content-Type: text/markdown
 
 # Capytaine: a linear potential flow BEM solver with Python.

{capytaine-2.3.1 → capytaine-3.0.0a1}/docs/changelog.rst

@@ -7,6 +7,236 @@ Changelog
    :depth: 1
    :backlinks: none
 
+-----------------------------------
+New in version 3.0.0a1 (2026-02-02)
+-----------------------------------
+
+Version 3 includes a major rewrite of several internal modules, most notably
+the ``meshes`` module which has been rewritten from scratch.
+
+About the new mesh module
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* **No in-place mutation of the mesh objects.**
+  To make the maintenance of the mesh routines easier, all in-place transformation of the objects have been removed.
+  Code such as the following::
+
+    mesh = cpt.load_mesh("...")
+    mesh.translate_x(1.0)
+    mesh.keep_immersed_part()
+    mesh.show()  # Show translated and clipped mesh
+
+  can be rewritted as::
+
+    mesh = cpt.load_mesh("...")
+    mesh = mesh.translated_x(1.0)
+    mesh = mesh.immersed_part()
+    mesh.show()
+
+  or more consisely::
+
+    mesh = cpt.load_mesh("...").translated_x(1.0).immersed_part()
+    mesh.show()
+
+  In the latter version, each line returns a new Python object of class
+  ``Mesh`` which is the object now referred to by the variable name ``mesh``.
+  The new version makes it less error prone to have complex workflows such as::
+
+    full_mesh = cpt.load_mesh("...")
+    full_mesh_draft = full_mesh.vertices[:, 2].min()
+    for draft in [1.0, 2.0, 3.0]:
+        mesh = full_mesh.translated_z(full_mesh_draft - draft).immersed_part()
+    ...
+
+  without any risk to overwriting the original ``full_mesh``.
+
+  The only usage of in-place transformations is for performance critical part of the code.
+  Given that most hydrodynamical meshes are usually below 100k faces, Capytaine's mesh class is usually not the performance bottleneck.
+  Computation intensive mesh transformations should be done with a dedicated meshing tool and not directly in Capytaine anyway.
+  If you find yourself nonetheless struggling with performance issues of the new mesh module in Capytaine, please open an issue on Github.
+
+* **No in-place mutation of the body objects.**
+  For the same reasons as above, the in-place transformations of the ``FloatingBody`` object have been removed.
+
+  Code such as the following::
+
+    body = cpt.FloatingBody(mesh=mesh)
+    body.rotation_center = (0, 0, -1)
+    body.add_all_rigid_body_dofs()
+    body.keep_only_dofs(['Heave'])
+    body.keep_immersed_part()
+    body.translate([0, 1, 0])
+
+  can be rewritten as::
+
+    body = cpt.FloatingBody(
+      mesh=mesh,
+      dofs=cpt.rigid_body_dofs(rotation_center=(0, 0, -1))
+    )
+    body = body.with_only_dofs(['Heave'])
+    body = body.immersed_part()
+    body = body.translated([0, 1, 0])
+
+* **Only a few built-in mesh loaders, but transparently use external libraries**
+  Only the domain mesh file formats (Nemoh's, WAMIT's, Hydrostar's and HAMS's) are built-in in Capytaine.
+  Loading a mesh in a general purpose file format such as GMSH or STL is still
+  easy, assuming a third party library supporting this file format is installed
+  (see :doc:`user_manual/mesh`).
+
+* **No more mesh writers**
+  To reduce the burden of maintenance, mesh writers have been removed, but the
+  mesh objects can be exported to external libraries that can write mesh files.
+  As a consequence ``export_as_Nemoh_directory`` has been moved out of Capytaine.
+
+* **Symmetries are only available around the main axis.**
+  The ``Plane`` and ``Axis`` objects have been removed.
+  Symmetric meshes using ``ReflectionSymmetricMesh`` can now only be defined for global symmetries across the ``'xOz'`` and ``'yOz'`` planes.
+  Other planes and local symmetries used to be supported in the previous version of Capytaine, but they were making the implementation much more complicated for little practical gain, so it has been chosen for this new version to reduce the scope but make sure that this feature is well integrated with all the other features of Capytaine
+  Similarly, transformations with the ``mirrored`` and ``rotated`` methods don't work with arbitrary plane or axis anymore.
+  Most transformation can still be performed by combining translation, rotation and mirroring.
+  More complex transformations should be done in a dedicated meshing software.
+
+* **Rotation symmetric meshes have been completely reworked.**
+  They are now well integrated with the other features such as irregular frequencies removal.
+  The user interface has been changed since the experimental methods from previous versions.
+  See :class:`~capytaine.meshes.symmetric_meshes.RotationSymmetricMesh`.
+  The method to create a symmetric mesh from a profile of points has also changed, see :meth:`~capytaine.meshes.symmetric_meshes.RotationSymmetricMesh.from_profile_points`.
+
+* **Prototype translation symmetry has been removed.**
+  As a consequence, the ``translation_symmetry`` arguments of the mesh generations functions has been removed.
+
+* ``Mesh.clipped`` and ``FloatingBody.clipped`` don't take as argument a
+  ``Plane`` object, but directly a point and a normal (as two 3-ple of floats).
+
+* If no name is provided, no generic name is given to the mesh, no name is used.
+  Meshes' names are only useful to keep track of Python objects, since printing the full list of points and faces is not very convenient.
+
+* Default 3D display now uses ``pyvista`` as a backend instead of raw ``vtk``. Please consider installing ``pyvista``.
+  Animation support has not been implemented in this new backend yet, only static mesh viewing is available.
+  The ``matplotlib`` backend is also still available for static mesh viewing.
+  Some keyword argument might have been changed to uniformize usage of the two 3D backends.
+
+* The barely-used and barely-documented ``geometric_center`` attribute of the mesh and the bodies have been removed.
+
+* Support for optionallay using quadratures from Quadpy has been removed.
+
+Other major changes
+~~~~~~~~~~~~~~~~~~~
+
+* Add :class:`~capytaine.bodies.multibodies.Multibody` meant to represent a
+  multibody system. For hydrodynamics, this is equivalent to the previous
+  behavior of coalescing bodies together. For hydrostatics, the new class
+  is slightly more powerful, for instance by being able to keep track of
+  several center of buoyancy and center of mass. (:pull:`822`)
+
+  Joining bodies with :meth:`~capytaine.bodies.bodies.FloatingBody.join_bodies`
+  or ``+`` now creates a :class:`~capytaine.bodies.multibodies.Multibody` instance. It can be converted back to a
+  :class:`~capytaine.bodies.bodies.FloatingBody` instance with::
+
+    both = body_1 + body_2  # `both` is now a Multibody
+    both = (body_1 + body_2).as_FloatingBody()  # Recover former behavior of joining FloatingBody with a FloatingBody
+
+* New internal data model for rigid body dofs with the classes
+  :class:`~capytaine.bodies.dofs.TranslationDof` and
+  :class:`~capytaine.bodies.dofs.RotationDof`. (:pull:`838`)
+  This should ensure that rigid dofs are detected and treated as such, without
+  relying only on their name.
+  This is relevant for multiple bodies and articulated bodies when computing:
+    * hydrostatics, where the exact hydrostatic stiffness formula for rigid body dofs can be used instead of the approximation for generalized dofs.
+    * forward speed, where the m-term is currently only implemented for rigid dofs.
+
+
+Minor changes
+~~~~~~~~~~~~~
+
+* Add option :code:`'lu_decomposition_with_overwrite'` for the :code:`linear_solver` of :class:`~capytaine.bem.engines.BasicMatrixEngine`, which reduces the RAM usage of the solver (:pull:`775`).
+
+* Velocity in the fluid can be post-processed in the limit frequencies (:math:`\omega = 0` or :math:`\omega = \infty`). Divide it by :math:`\omega` to have a finite value (:pull:`777`).
+
+* Display in the log the RAM usage estimation before a batch resolution and the measured RAM usage at the end of the resolution (:pull:`784`)
+
+* **Breaking** When building the dataset in :meth:`~cpt.bem.solver.fill_dataset`, the previous ``kochin`` attribute has been renamed to ``kochin_radiation``
+  to be consistent with the existing ``kochin_diffraction`` attribute.
+
+* **Breaking** Remove the geometric body classes ``cpt.Sphere()``,
+  ``cpt.VerticalCylinder()``, ``cpt.HorizontalCylinder()``, ``cpt.Disk()``,
+  ``cpt.Rectangle()``, ``cpt.RectangularParallelepiped()``, that were marked as
+  deprecated since version 2.0. Consider using instead::
+
+    cpt.FloatingBody(mesh=cpt.mesh_sphere(...), ...)
+
+  or something equivalent, separating the geometric mesh generation from the
+  floating body definition.
+
+* :func:`~capytaine.bodies.dofs.rigid_body_dofs` now instantiate the new dof class instead of a placeholder.
+  It now has an additional input argument ``only`` to have only some of the six rigid body dofs.
+  Also a rotation center should be passed, because the properties of the body
+  (e.g. `center_of_mass`) cannot be accessed at that stage. (:pull:`838`)
+
+Bug fixes
+~~~~~~~~~
+
+* Fix type of the right-hand-side of the linear solver when using option :code:`floating_point_precision = 'float32'` in :class:`~capytaine.green_functions.delhommeau.Delhommeau`.
+  As a consequence, the whole computation is done in single precision and the RAM usage is lower as expected. (:pull:`774`)
+
+* Fix the timer for parallel resolution, i.e. when :code:`n_jobs` is greater than 1. Now the durations for each process are displayed. (:pull:`782`)
+
+* Hydrostatics methods better take into account the free surface even when
+  the mesh has not been clipped yet.
+  Internally, the mesh is clipped before computing methods such as
+  :meth:`~cpt.bodies.bodies.FloatingBody.disp_volume` or
+  :meth:`~cpt.bodies.bodies.FloatingBody.center_of_buoyancy`, such that the
+  computed displaced volume is always actually the volume below $z=0$ and the
+  center of buoyancy is always below the free surface.
+  The inertia matrix always uses the displaced water mass for the mass and
+  compute the inertia moments on the full shape if the full mesh is provided.
+  (:pull:`794`)
+
+* Fix the frequency type in the dimensions of the dataset returned by :meth:`~cpt.io.xarray.kochin_data_array`. Previously, the dimension was always named ``omega``;
+  it is now named ``omega``, ``freq``, ``period``,  ``wavenumber`` or ``wavelength`` depending on the user settings.
+
+* Fix a bug when computing the Kochin function on a mesh with a lid. The Kochin function now also takes the faces on the lid into account. (:issue:`833`)
+
+Internals
+~~~~~~~~~
+
+* **Breaking** The ``green_function`` is not an attribute of the :class:`~capytaine.bem.solver.BEMSolver` anymore, but of the engine.
+  The motivation is that not all engines can be made compatible with all Green function implementations (although the builtins one are).
+  The possibility to call ``BEMSolver(green_function=...)`` is kept as a convenient shortcut to ``BEMSolver(engine=BasicMatrixEngine(green_function=...))``.
+  Calls to ``BEMSolver(green_function=..., engine=...)`` now raise an error. (:pull:`752`)
+  Post-processing new requires the implementation of the methods ``build_S_matrix`` and ``build_fullK_matrix`` by the engine (:pull:`753`)
+
+* New implementation of the block symmetric matrices for mesh symmetry, now
+  used by :class:`~capytaine.bem.engines.BasicMatrixEngine` (:pull:`754`).
+
+* Rafactor of the :class:`~capytaine.bem.engines.BasicMatrixEngine` to make the
+  caching more straightforward and improve its interaction with LU
+  decomposition and symmetries. (:pull:`755`)
+
+* The whole ``matrices`` module as well as the corresponding engines in
+  ``bem/engines.py`` and ``tool/lru_caches.py`` have been removed from
+  Capytaine. For compatibility, they will remain accessible from a separate
+  package. (:pull:`757`, :pull:`765`)
+
+* Instead of creating a ``CollectionOfMeshes``, now ``join_bodies`` merges the
+  meshes of the bodies together. The legacy behavior is still available from
+  Fakeblocks ``join_bodies``. (:pull:`779`)
+
+* The new ``Mesh`` class has a ``faces_metadata`` attribute storing fields
+  defined on each faces of the mesh. When faces are added or removed, the
+  metadata are automatically updated accordingly. (:pull:`791`)
+
+* Move hydrostatics routines in a dedicated module and rewrite corresponding tests (:pull:`794`)
+
+* Refactor the implementation of the timer to make it easier to include more steps (:pull:`809`)
+
+* Parameters ``free_surface``, ``water_depth`` and ``wavenumber`` are always
+  keyword arguments in the engine and the Green function (:pull:`812`)
+
+* **Breaking** :meth:`~capytaine.bodies.FloatingBody.add_rotation_dof` takes
+  arguments called ``rotation_center`` and ``direction`` instead of an ``Axis``
+  object. Also the geometric center is not used anymore as a fallback value for
+  ``rotation_center``.
 
 ---------------------------------
 New in version 2.3.1 (2025-10-14)

{capytaine-2.3.1 → capytaine-3.0.0a1}/docs/conf.py

@@ -50,7 +50,7 @@ extensions = [
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
-    'sphinx_toolbox.collapse',
+    'sphinx_tabs.tabs',
     'sphinx_proof',
     'sphinx_copybutton',
     'sphinxcontrib.mermaid',