Skip to content
Snippets Groups Projects
Commit fb993afa authored by Oriol.Tinto's avatar Oriol.Tinto
Browse files

Update contribute.rst

parent 6475ee54
No related branches found
No related tags found
1 merge request!21Update file compress_dataset_without_enstools_write.ipynb
Pipeline #21691 failed
...@@ -9,4 +9,4 @@ Extending the Tool ...@@ -9,4 +9,4 @@ 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. 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>`_. Once the Python interface exists, the only additional required step is to add the filter definitions to `GitHub page <https://github.com/wavestoweather/enstools-encoding/>`_. It involves minimal additional work, adding only few lines to a `single file <https://github.com/wavestoweather/enstools-encoding/blob/main/enstools/encoding/definitions.py>`_.
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment