Installation

Requirements

  • Python 3.10 or newer

  • numpy >= 1.24

  • scipy >= 1.10

Optional dependencies:

  • matplotlib >= 3.7 (needed to run the example scripts)

  • sphinx >= 7.2 + furo >= 2024.8.6 (needed to build these docs)

Install from the package directory

Standard editable install (recommended for development):

cd packages/integrationdifferentiation
pip install -e .

Install with plotting support (required to run the example scripts):

pip install -e ".[plot]"

Install with full development and documentation dependencies:

pip install -e ".[dev,docs]"

Verify the installation

import integrationdifferentiation
print(integrationdifferentiation.__doc__)

Build the HTML documentation

After installing the docs extras, run from the docs/ directory:

# Linux / macOS
make html

# Windows
make.bat html

The generated site is written to docs/_build/html/index.html.

You can also launch the pre-built docs programmatically:

from integrationdifferentiation import launch_documentation
launch_documentation()