Installation¶

Dependencies¶

The guidata package requires the following Python modules:

Name	Version	Summary
Python	>=3.9, <4	Python programming language
h5py	>= 3.6	Read and write HDF5 files from Python
NumPy	>= 1.22	Fundamental package for array computing in Python
QtPy	>= 1.9	Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
requests		Python HTTP for Humans.
tomli	(python_version < ‘3.11’)	A lil’ TOML parser

Optional modules for GUI support (Qt):

Name	Version	Summary
PyQt5	> 5.15.5	Python bindings for the Qt cross platform application toolkit

Optional modules for development:

Name	Version	Summary
build		A simple, correct Python build frontend
babel		Internationalization utilities
Coverage		Code coverage measurement for Python
pylint		python code static checker
ruff		An extremely fast Python linter and code formatter, written in Rust.
pre-commit		A framework for managing and maintaining multi-language pre-commit hooks.

Optional modules for building the documentation:

Name	Version	Summary
PyQt5	> 5.15.5	Python bindings for the Qt cross platform application toolkit
pillow		Python Imaging Library (fork)
pandas		Powerful data structures for data analysis, time series, and statistics
sphinx		Python documentation generator
myst_parser		An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
sphinx-copybutton		Add a copy button to each of your code cells.
sphinx_qt_documentation		Plugin for proper resolve intersphinx references for Qt elements
python-docs-theme		The Sphinx theme for the CPython docs and related projects

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.

The easiest way to install guidata is using pip:

pip install guidata

To install from source, clone the repository or download the source package from PyPI.

Then run the following command (using build):

python -m build