PoreStore Python SDK¶

PoreStore's Python client transfers images, submits remote scientific analyses, and retrieves results from scripts and notebooks. Scientific calculations run through PoreStore; the SDK manages connections, job status and local caches. The distribution and import name are both porestore.

The SDK is in alpha. Until the first PyPI release is published, install from a local checkout with python -m pip install -e /path/to/porestore_sdk. Once an alpha release is available, install it with:

python -m pip install --pre porestore

Python 3.12 or later is required. Keep the SDK environment separate from the PoreStore application environment because both use the same package name.

The notebook workflow covers connection settings, image transfer, job recovery, units and errors. The analysis guide describes supported calculations and their service-defined parameters. The API reference is generated from the current Python source and docstrings on each build, including public classes, methods and tool functions.

These pages describe the latest main branch, which can include changes beyond the most recent package release. Release notes identify published versions. The SDK is distributed under the MIT license.