From 6475ee5484ca5a01c69d3a1e88136a2a1505e25a Mon Sep 17 00:00:00 2001 From: "Oriol.Tinto" <oriol.tinto@physik.uni-muenchen.de> Date: Mon, 19 Aug 2024 14:50:34 +0000 Subject: [PATCH] Update contribute.rst --- docs/source/contribute.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index 63d8189..7f85b2b 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -3,7 +3,10 @@ Contribute Bug Reporting ------------- +To **report a bug** or to **request an enhancement**, please use the `Issue tracker <https://github.com/wavestoweather/enstools-compression/issues>`_ from our `GitHub page <https://github.com/wavestoweather/enstools-compression/>`_. -To **report a bug** or to **request an enhancement** please use the `Issue tracker <https://github.com/wavestoweather/enstools-compression/issues>`_ from our `Github page <https://github.com/wavestoweather/enstools-compression/>`_ . - +Extending the Tool +------------------ +To extend the tool with a new plugin that already has an HDF5 plugin available, a Python interface is required. Good examples of how filter interfaces look can be found in this `source file <https://github.com/silx-kit/hdf5plugin/blob/main/src/hdf5plugin/_filters.py>`_. In case of developing a new interface, it is advisable to integrate this interface into the `hdf5plugin repository <https://github.com/silx-kit/hdf5plugin>`_, so a wider audience can benefit from it. +Once the Python interface is established, adding the filter definitions to *enstools-encoding* involves minimal additional work, requiring you to extend only a `single file <https://github.com/wavestoweather/enstools-encoding/blob/main/enstools/encoding/definitions.py>`_. \ No newline at end of file -- GitLab