doc/autosum.rst

CHANGES.md

@@ -1,7 +1,7 @@
 # Release notes
 
 See also the
-[unreleased changes](https://foss.heptapod.net/fluiddyn/fluidimage/-/compare/0.4.5...branch%2Fdefault).
+[unreleased changes](https://foss.heptapod.net/fluiddyn/fluidimage/-/compare/0.4.6...branch%2Fdefault).
 
 ## [0.4.6] (2024-04-20)
 

doc/autosum.rst

@@ -1,6 +1,8 @@
 API reference
 -------------
 
+Fluidimage contains the following subpackages
+
 .. autosummary::
    :toctree: _generated/
 
@@ -9,13 +11,29 @@ API reference
    fluidimage.data_objects
    fluidimage.works
    fluidimage.calcul
-   fluidimage.bos
-   fluidimage.optical_flow
-   fluidimage.piv
-   fluidimage.preproc
-   fluidimage.image2image
    fluidimage.calibration
    fluidimage.reconstruct
    fluidimage.postproc
    fluidimage.util
    fluidimage.gui
+
+We have also few utility modules:
+
+.. autosummary::
+   :toctree: _generated/
+
+   fluidimage.config
+   fluidimage.run_from_xml
+   fluidimage.synthetic
+   fluidimage.uvmat
+
+Finally, there are few modules to improve the API for common processing:
+
+.. autosummary::
+   :toctree: _generated/
+
+   fluidimage.bos
+   fluidimage.optical_flow
+   fluidimage.piv
+   fluidimage.preproc
+   fluidimage.image2image

pixi.toml

@@ -7,7 +7,7 @@ platforms = ["linux-64", "win-64", "osx-64", "osx-arm64"]
 # use as `pixi run install-editable`
 install-dependencies = "pixi install"
 install-editable = {cmd = "pip install -e . -v --no-build-isolation --no-deps", depends_on = ["install-dependencies"]}
-test = "export OMP_NUM_THREADS=1 && pytest src -v"
+test = "export OMP_NUM_THREADS=1 && pytest src -v -s"
 
 [dependencies]
 python = ">=3.9,<3.11"

src/fluidimage/config.py

@@ -1,15 +1,19 @@
+"""Handle Fluidimage configuration"""
+
 import os
 from configparser import ConfigParser
 
 
 def get_config():
+    """Get configuration from .fluidimagerc"""
     config = ConfigParser()
 
     home = os.path.expanduser("~")
     path_config = os.path.join(home, ".fluidimagerc")
 
-    if os.path.exists(path_config):
-        config.read(path_config)
+    if not os.path.exists(path_config):
+        return {}
+    config.read(path_config)
 
     config_dict = {}
     for section in config.sections():

src/fluidimage/synthetic.py

@@ -1,3 +1,5 @@
+"""Production of synthetic images"""
+
 import numpy as np
 
 
@@ -9,6 +11,7 @@ def make_synthetic_images(
     epsilon=0.0,
     part_size=np.sqrt(1 / 0.5),
 ):
+    """Produce synthetic images for testing PIV"""
     ny, nx = tuple(shape_im0)
 
     displacement_x, displacement_y = tuple(displacements)