Documentation and user guide notebooks

docs/source/index.rst

@@ -6,28 +6,35 @@
 OSmOSE_post_processing documentation
 ====================================
 
-OSmOSE_post_processing is an open-source python repository to process passive acoustic data particularly marine mammals automatic detections and manual annotations.
+**OSmOSE_post_processing** is an open-source python repository to process passive acoustic data particularly marine mammals automatic detections and manual annotations.
 All results are formatted to suit `OSmOSE <https://github.com/Project-OSmOSE/>`_ convention.
 
 ====================
 
 :ref:`Installation <installation>`
 ----------------------------------
 
-Instructions on how to install OSmOSE_post_processing.
+Instructions on how to install **OSmOSE_post_processing** package.
 
 ====================
 
 :ref:`Usage <usage>`
 ----------------------------------
 
-Instructions on how to use **OSmOSE_post_processing**.
+Instructions on how to use **OSmOSE_post_processing** package.
+
+====================
+
+:ref:`Examples <examples>`
+----------------------------------
+
+A set of jupyter notebooks that complete typical tasks.
 
 
 ====================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :includehidden:
 
    installation

docs/source/installation.rst

@@ -3,18 +3,18 @@
 
 .. _installation:
 
-To use **OSmOSE_post_processing**, you first need to install it using the following procedure:
+To use **OSmOSE_post_processing**, you first need to install it using one of the following:
 
 From Git
 --------
 
-You can install **OSmOSE_post_processing** from `git <https://git-scm.com/>`_ if you want to have an editable version of it. This can be usefull for contributing to **OSEkit**, or to be able to easily update to the latest version.
+You can install **OSmOSE_post_processing** from `git <https://git-scm.com/>`_ if you want to have an editable version of it. This can be usefull for contributing to **OSmOSE_post_processing**, or to be able to easily update to the latest version.
 
-The package will be installed with `uv <https://docs.astral.sh/uv/>`_, which is a Python package and project manager. Please refer to the `uv documentation <https://docs.astral.sh/uv/getting-started/installation/>`_ for installing uv.
+The package will be installed with `uv <https://docs.astral.sh/uv/>`_, which is a Python package and project manager. Please refer to the `documentation <https://docs.astral.sh/uv/getting-started/installation/>`_ for installation.
 
 To download the repository, simply clone it from git: ::
 
-    git clone https://github.com/mathieudpnt/OSmOSE_post_processing.git
+    git clone https://github.com/Project-OSmOSE/OSmOSE_post_processing.git
 
 Then, you can pull the latest update: ::
 
@@ -25,3 +25,14 @@ You can now install the package using uv from the cloned repository: ::
     uv sync
 
 This will create a virtual environment within your cloned repository and install all required dependencies for using and contributing to **OSmOSE_post_processing**.
+
+
+With pip
+--------
+
+Alternatively, you can install it with a wheel file for any of our releases:
+
+* Get the ``.whl`` wheel file from `the github repository <https://github.com/Project-OSmOSE/OSmOSE_post_processing/releases>`_.
+* Install it in a virtual environment using pip: ::
+
+    pip install post_processing-x.x.x.-py3-none-any.whl

docs/source/usage.rst

@@ -3,5 +3,22 @@
 
 .. _usage:
 
-In **OSmOSE_post_processing**, ...
+In **OSmOSE_post_processing**, data is manipulated through `DataAplose` objects.
 
+====================
+
+.. topic:: :ref:`Overview <example_overview>`
+    sentence
+
+.. topic:: :ref:`Single barplot <example_single_barplot>`
+    sentence
+
+.. topic:: :ref:`Multi barplot <example_multi_barplot>`
+    sentence
+
+.. toctree ::
+    :hidden:
+
+    publicapi_usage
+    coreapi_home
+    multiprocessing