|
| 1 | +.. ## for plotting and for examples |
| 2 | + #TODO Need to be updated if it's necessary |
| 3 | +.. |MatplotlibMinVersion| replace:: 3.9.0 |
| 4 | +.. |SeabornMinVersion| replace:: 0.9.0 |
| 5 | + |
| 6 | +Quick start for contributing |
| 7 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 8 | +Source code |
| 9 | +""""""""""" |
| 10 | + |
| 11 | +You can check out the latest sources with the command: |
| 12 | + |
| 13 | +.. code-block:: sh |
| 14 | +
|
| 15 | + git clone https://github.com/mind-inria/hidimstat.git |
| 16 | +
|
| 17 | +Test suite |
| 18 | +"""""""""" |
| 19 | + |
| 20 | +For testing, we recommend you install the test dependencies with pip: |
| 21 | + |
| 22 | +.. code-block:: sh |
| 23 | +
|
| 24 | + pip install -e '.[test]' |
| 25 | + |
| 26 | +This will install ``pytest`` and the following extensions: |
| 27 | +``pytest-cov``, ``pytest-randomly``, ``pytest-xdist``, ``pytest-html``, |
| 28 | +``pytest-timeout``, ``pytest-durations`` |
| 29 | + |
| 30 | +After this installation, you can launch the test suite: |
| 31 | + |
| 32 | +.. code-block:: sh |
| 33 | +
|
| 34 | + pytest test |
| 35 | +
|
| 36 | +Examples |
| 37 | +"""""""" |
| 38 | + |
| 39 | +To run the examples, we recommend you install the example dependencies with pip: |
| 40 | + |
| 41 | +.. code-block:: sh |
| 42 | +
|
| 43 | + pip install -e '.[example]' |
| 44 | +
|
| 45 | +For running the examples, it's necessary to install Matplotlib >= |MatplotlibMinVersion| and seaborn >= |
| 46 | +|SeabornMinVersion|. |
| 47 | + |
| 48 | +| After this installation, you can run any example in the `examples <https://github.com/mind-inria/hidimstat/tree/main/examples>`_ folder. |
| 49 | +| Or you can download some of them from the `documentation <https://hidimstat.github.io/dev/auto_examples/index.html>`_. |
| 50 | +
|
| 51 | +Documentation |
| 52 | +""""""""""""" |
| 53 | + |
| 54 | +The documentation is built with Sphinx. We recommend you install the documentation dependencies with pip: |
| 55 | + |
| 56 | +.. code-block:: sh |
| 57 | +
|
| 58 | + pip install -e '.[doc]' |
| 59 | +
|
| 60 | +After this installation, you can build the documentation from the source using the Makefile in doc_conf: |
| 61 | + |
| 62 | +.. code-block:: sh |
| 63 | +
|
| 64 | + make html |
| 65 | +
|
| 66 | +**For more information**, look at the `developer documentation <https://hidimstat.github.io/dev/dev/index.html>`_ |
0 commit comments