Big update to documentation

cgadal-pythonpackages · Sep 1, 2023 · 946ecda · 946ecda
1 parent 28de1ef
commit 946ecda
Show file tree

Hide file tree

Showing 293 changed files with 370 additions and 2,563 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,22 @@
 # pyudv
+
+pyudv is a python package allowing to read and process UDV data. The main modules are:
+
+- `pyudv.read_mfprof`, which helps you read binary files from Met-Flow UDVs
+- `pyudv.probes`, which helps you plot the various probes, calculate the intersection points, etc ..
+- `pyudv.velocity`, which helps you reconstruct 2D velocity fields from the various probes measurements
+- `pyudv.amplitude`, which helps you infer concentration from amplitude measurements
+
+> [!WARNING]  
+> Although tested, this is still in development, use with caution. Feedbacks welcome.
+
+### Installation
+
+#### User only
+
+Using `pip3 install --upgrade https://github.com/cgadal-pythonpackages/pyudv/tarball/master`
+
+#### If code or development
+
+- clone the repository, e.g. `git clone https://github.com/cgadal-pythonpackages/pyudv`
+- `cd pyudv && pip3 install -e ./` will install in editable mode.
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.alpha_w.rst b/docs/_autosummary/pyudv.amplitude.direct_models.alpha_w.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.correction_factor.rst b/docs/_autosummary/pyudv.amplitude.direct_models.correction_factor.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.create_MSvoltage.rst b/docs/_autosummary/pyudv.amplitude.direct_models.create_MSvoltage.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.cumulative_trapezoid.rst b/docs/_autosummary/pyudv.amplitude.direct_models.cumulative_trapezoid.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.near_field_theoretical.rst b/docs/_autosummary/pyudv.amplitude.direct_models.near_field_theoretical.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.rst b/docs/_autosummary/pyudv.amplitude.direct_models.rst
diff --git a/docs/_autosummary/pyudv.amplitude.direct_models.sound_velocity.rst b/docs/_autosummary/pyudv.amplitude.direct_models.sound_velocity.rst
diff --git a/docs/_autosummary/pyudv.amplitude.inversion.correction_factor.rst b/docs/_autosummary/pyudv.amplitude.inversion.correction_factor.rst
diff --git a/docs/_autosummary/pyudv.amplitude.inversion.explicit_inversion.rst b/docs/_autosummary/pyudv.amplitude.inversion.explicit_inversion.rst
diff --git a/docs/_autosummary/pyudv.amplitude.inversion.rst b/docs/_autosummary/pyudv.amplitude.inversion.rst
diff --git a/docs/_autosummary/pyudv.amplitude.rst b/docs/_autosummary/pyudv.amplitude.rst
diff --git a/docs/_autosummary/pyudv.helpers.create_arboresence.rst b/docs/_autosummary/pyudv.helpers.create_arboresence.rst
diff --git a/docs/_autosummary/pyudv.helpers.moving_std.rst b/docs/_autosummary/pyudv.helpers.moving_std.rst
diff --git a/docs/_autosummary/pyudv.helpers.moving_std1d.rst b/docs/_autosummary/pyudv.helpers.moving_std1d.rst
diff --git a/docs/_autosummary/pyudv.helpers.rst b/docs/_autosummary/pyudv.helpers.rst
diff --git a/docs/_autosummary/pyudv.helpers.uniform_filter.rst b/docs/_autosummary/pyudv.helpers.uniform_filter.rst
diff --git a/docs/_autosummary/pyudv.helpers.uniform_filter1d.rst b/docs/_autosummary/pyudv.helpers.uniform_filter1d.rst
diff --git a/docs/_autosummary/pyudv.probes.Probe.plot_probe.rst b/docs/_autosummary/pyudv.probes.Probe.plot_probe.rst
diff --git a/docs/_autosummary/pyudv.probes.Probe.rst b/docs/_autosummary/pyudv.probes.Probe.rst
diff --git a/docs/_autosummary/pyudv.probes.compute_vertical_axis.rst b/docs/_autosummary/pyudv.probes.compute_vertical_axis.rst