Setup format .md

Author: paugier

.mdformat.toml

@@ -1,3 +1,6 @@
 wrap = 89
 number = true
 end_of_line = "lf"
+
+# Python 3.13+ only:
+# exclude = []

README.md

@@ -61,14 +61,13 @@ achieved by using
 ## Installation and setup
 
 Fluidimage can be installed from
-[wheels and sdist available on PyPI](https://pypi.python.org/pypi/fluidimage/)
-with tools like pip, [UV], [PDM], ... or from conda-forge packages (for example
-available on https://prefix.dev/channels/conda-forge/packages/fluidimage) with
-tools like conda (installed with [Miniforge]) or [Pixi].
+[wheels and sdist available on PyPI](https://pypi.python.org/pypi/fluidimage/) with tools
+like pip, [UV] and [PDM]. Alternatively, it can be installed from conda-forge packages
+(for example available on https://prefix.dev/channels/conda-forge/packages/fluidimage)
+with tools like conda (installed with [Miniforge]) or [Pixi].
 
-In some cases, Fluidimage will require that the environment variable
-`OMP_NUM_THREADS` is set to `1`. With a POSIX shell like Bash, it can be done with
-`export OMP_NUM_THREADS=1`.
+In some cases, Fluidimage will require that the environment variable `OMP_NUM_THREADS` is
+set to `1`. With a POSIX shell like Bash, it can be done with `export OMP_NUM_THREADS=1`.
 
 For more details, see
 [the installation page in the documentation](https://fluidimage.readthedocs.io/en/latest/install.html).
@@ -93,12 +92,12 @@ journal = {Journal of Open Research Software}
 
 ```
 
+[miniforge]: https://github.com/conda-forge/miniforge
 [openpiv]: http://www.openpiv.net/
+[pdm]: https://pdm-project.org
 [piv]: https://en.wikipedia.org/wiki/Particle_image_velocimetry
 [pivlab]: https://pivlab.blogspot.com/p/what-is-pivlab.html
 [pivmat]: http://www.fast.u-psud.fr/pivmat/
-[uvmat]: http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki/UvmatHelp
-[miniforge]: https://github.com/conda-forge/miniforge
 [pixi]: https://pixi.sh
-[pdm]: https://pdm-project.org
 [uv]: https://docs.astral.sh/uv/
+[uvmat]: http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki/UvmatHelp

doc/uvmat.md

@@ -18,10 +18,10 @@ Loop on every grid points:
 
 2.1: crop of subimages A and B of images A and B
 
-subA is centered in \[xA, yA\] and has a size \[Lx, Ly\]
+subA is centered in `[xA, yA]` and has a size `[Lx, Ly]`
 
-subB is centered in \[xA + shitfx, xB + shifty\] and has a size \[Sx, Sy\] with Sx,Sy >
-Lx, Ly
+subB is centered in `[xA + shitfx, xB + shifty]` and has a size `[Sx, Sy]` with `Sx,Sy > Lx,
+Ly`
 
 2.2: if checkmask == 1 -> application of the mask on subimages
 
@@ -35,19 +35,19 @@ conv = conv2(subA, subB, 'valid');
 % be careful on the ordering of subB
 ```
 
-2.4.2 search displacement \[dx, dy\] corresponding such that
+2.4.2 search displacement `[dx, dy]` corresponding such that
 
 ```matlab
 conv(dx, dy) == corrmax
 % corrmax = max( max( conv));
 ```
 
-2.5 subpixel determination of displacement: \[vec_x, vec_y\] = fct(conv, dx, dy)
+2.5 subpixel determination of displacement: `[vec_x, vec_y] = fct(conv, dx, dy)`
 
 it exists 3 different fct depending on parameters: SUBPIXGAUSS, SUBPIX2DGAUSS and
 quadr_fit
 
-2.6 if the position \[xA + vec_x, yA + vec_y\] is in the mask -> vec_x, vec_y is put to 0
+2.6 if the position `[xA + vec_x, yA + vec_y]` is in the mask -> vec_x, vec_y is put to 0
 
 2.7 the maximum correlation is normalised