Installation

This section provides instructions on how to install and set up the Sigima project, including dependencies and environment configuration.

How to install

Sigima is available in several forms:

• As a Conda package.

• As a Python package, which can be installed using the Package manager pip.

• As a precompiled Wheel package, which can be installed using pip.

• As a Source package, which can be installed using pip or manually.

See also

Impatient to try the next version of Sigima? You can also install the latest development version of Sigima from the master branch of the Git repository. See Development version for more information.

Conda package

GNU/Linux Windows macOS

To install sigima package from the conda-forge channel (https://anaconda.org/conda-forge/sigima), run the following command:

$ conda install conda-forge::sigima

Package manager pip

GNU/Linux Windows macOS

Sigima’s package sigima is available on the Python Package Index (PyPI) on the following URL: https://pypi.python.org/pypi/sigima.

Installing Sigima from PyPI is as simple as running this command (you may need to use pip3 instead of pip on some systems):

$ pip install sigima

Note

If you already have a previous version of Sigima installed, you can upgrade it by running the same command with the --upgrade option:

$ pip install --upgrade sigima

Wheel package

GNU/Linux Windows macOS

On any operating system, using pip and the Wheel package is the easiest way to install sigima on an existing Python distribution:

$ pip install --upgrade Sigima-0.3.0-py2.py3-none-any.whl

Source package

GNU/Linux Windows macOS

Installing Sigima directly from the source package may be done using pip:

$ pip install --upgrade sigima-0.3.0.tar.gz

Or, if you prefer, you can install it manually by running the following command from the root directory of the source package:

$ pip install --upgrade .

Finally, you can also build your own Wheel package and install it using pip, by running the following command from the root directory of the source package (this requires the build and wheel packages to be installed):

$ pip install build wheel  # Install build and wheel packages (if needed)
$ python -m build  # Build the wheel package
$ pip install --upgrade dist/sigima-0.3.0-py2.py3-none-any.whl  # Install the wheel package

Development version

GNU/Linux Windows macOS

If you want to try the latest development version of Sigima, you can install it directly from the master branch of the Git repository.

The first time you install Sigima from the Git repository, enter the following command:

$ pip install git+https://github.com/DataLab-Platform/Sigima.git

Then, if at some point you want to upgrade to the latest version of Sigima, just run the same command with options to force the reinstall of the package without handling dependencies (because it would reinstall all dependencies):

$ pip install --force-reinstall --no-deps git+https://github.com/DataLab-Platform/Sigima.git

Note

If dependencies have changed, you may need to execute the same command as above, but without the --no-deps option.

Dependencies

The sigima package requires the following Python modules:

Name	Version	Summary
Python	>=3.9, <4	Python programming language
guidata	>= 3.13	Automatic GUI generation for easy dataset editing and display
NumPy	>= 1.22, < 2.5	Fundamental package for array computing in Python
SciPy	>= 1.10.1, < 1.17	Fundamental algorithms for scientific computing in Python
scikit-image	>= 0.19.2, < 0.27	Image processing in Python
pandas	>= 1.4, < 3.1	Powerful data structures for data analysis, time series, and statistics
PyWavelets	>= 1.2, < 2.0	PyWavelets, wavelet transform module
packaging	>= 21.3	Core utilities for Python packages
typing-extensions	>= 4.0	Backported and Experimental Type Hints for Python 3.9+
makefun	>= 1.13.1	Small library to dynamically create python functions.

Optional modules for GUI support (Qt):

Name	Version	Summary
qtpy		Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
PyQt5		Python bindings for the Qt cross platform application toolkit
plotpy		Curve and image plotting tools for Python/Qt applications

Optional modules for development:

Name	Version	Summary
build		A simple, correct Python build frontend
babel		Internationalization utilities
ruff		An extremely fast Python linter and code formatter, written in Rust.
pylint		python code static checker
Coverage		Code coverage measurement for Python
pre-commit		A framework for managing and maintaining multi-language pre-commit hooks.
setuptools		Most extensible Python build backend with support for C/C++ extension modules
wheel		Command line tool for manipulating wheel files

Optional modules for building the documentation:

Name	Version	Summary
sphinx		Python documentation generator
sphinx-gallery		A Sphinx extension that builds an HTML gallery of examples from any set of Python scripts.
sphinx_intl		Sphinx utility that make it easy to translate and to apply translation.
myst_parser		An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
myst-nb		A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser.
sphinx_design		A sphinx extension for designing beautiful, view size responsive web components.
sphinx-copybutton		Add a copy button to each of your code cells.
pydata-sphinx-theme		Bootstrap-based Sphinx theme from the PyData community
qtpy		Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
PyQt5		Python bindings for the Qt cross platform application toolkit
plotpy		Curve and image plotting tools for Python/Qt applications
matplotlib		Python plotting package
opencv-python-headless	>= 4.8.1.78	Wrapper package for OpenCV python bindings.

Optional modules for running test suite:

Name	Version	Summary
pytest		pytest: simple powerful testing with Python
pytest-xvfb		A pytest plugin to run Xvfb (or Xephyr/Xvnc) for tests.