Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions doc/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This project follows the standard open-source project github workflow, which is
Testing
=======


To run self-contained tests, from Python:

.. code-block:: python
Expand All @@ -24,6 +25,36 @@ To also run tests relying on actual HDF5 files, run from the source directory::

This tests the installed version of `hdf5plugin`.

Example of an installation with conda for test
..............................................

1. `Install conda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>`_ if needed & create conda environment for testing

.. code-block:: bash

conda create -n hdf5plugins_env python=3.XX
conda activate hdf5plugins_env

2. Install requirements

.. code-block:: bash

conda install compilers
pip install py-cpuinfo setuptools

3. Build

.. code-block:: bash

python setup.py build

4. Run the test

.. code-block:: bash

PYTHONPATH=build/lib.linux-x86_64-cpython-3{XX}/ python test/test.py -vvv


Formatting/Linting
==================

Expand Down
Loading