Scientific library to quantify the difference between two images (2D or 3D).

do::

python3 setup.py build_ext --inplace

Building from source is required to work on a contribution (bug fix, new feature, code or documentation improvement).

1. Use Git to check out the latest source from the smetrics repository on GitLab.:

   git clone git://github.com/sylvainprigent/smetrics.git  # add --depth 1 if your connection is slow
   cd smetrics
   

   If you plan on submitting a pull-request, you should clone from your fork instead.

2. Install a compiler with OpenMP_ support for your platform.

3. Optional (but recommended): create and activate a dedicated virtualenv_ or `conda environment`_.

4. Install Cython_ and build the project with pip in :ref:`editable_mode`:

   pip install cython
   pip install --verbose --no-build-isolation --editable .
   

5. Check that the installed scikit-learn has a version number ending with .dev0:

   python -c "import smetrics; print(smetrics.__version__)"
   

do:

python3 setup.py bdist_wheel

run tests by running:

pytest smetrics

or

python3 -m pytest smetrics

python -m cProfile -o out_profile script_name.py cprofilev -f out_profile

without example gallery:

cd doc
make

with the example gallery (may take a while):

cd doc
make html