polartools
Python package to read and process data from the APS Polar beamline
- License: ANL OPEN SOURCE LICENSE
- Documentation: https://aps-4id-polar.github.io/polartools/latest/
Install
pip install polartools
Or, for a development checkout with the heavier native dependencies (Qt, HDF5 plugins) from conda:
mamba env create -f environment.yml
mamba activate polartools-dev
See the installation guide for the X11 system libraries Qt needs on Linux.
Graphical tools
Installing the package puts the beamline's viewers on your PATH:
| Command | What it opens |
|---|---|
scan-viewer [directory] |
Scan browser for a directory of *_master.hdf files, with the fluorescence-spectrum and image-stack windows behind its Spc and Img buttons |
flyscan-dichro-gui |
Post-scan flyscan dichroism viewer: CR/CL maps and their difference |
xmcd-gui |
Interactive XMCD normalization and dichroism |
Library
from polartools.load_data import load_table
table = load_table(scan_id=10, source="my_spec_file.dat", folder="/data/2024-1")
load_table reads SPEC files, HDF5, CSV folders, databroker catalogs and
tiled catalogs into a pandas DataFrame. See the
quickstart.
1 maintainer
Metadata
1 maintainer
Release files for polartools 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| polartools-0.7.0.tar.gz | 7.9 MB | With provenance | Details for polartools-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| polartools-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for polartools-0.7.0-py3-none-any.whl |
Total release size: 16.0 MB
Release files / polartools-0.7.0.tar.gz
| Download URL | polartools-0.7.0.tar.gz |
|---|---|
| Size | 7.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
542f853a38758b955072a22cb46dad35d287f2806bf907c22fe4c5044e2a13c1
|
|
BLAKE2b-256 checksum How to use checksums |
554879d48a82441afbbf68cf2f9687b8fc9804764caa8f19acbfd5a1ab0fe417
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logRelease files / polartools-0.7.0-py3-none-any.whl
| Download URL | polartools-0.7.0-py3-none-any.whl |
|---|---|
| Size | 8.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
070e8aba15c459d32266a016c401bdebd65999dca2ffb7af621c0b57eaca483f
|
|
BLAKE2b-256 checksum How to use checksums |
1dec60ece285577e330732b1036a1e29bc52f068ae63ea9be0e3292661e3b7ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logSecurity for polartools 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for polartools-0.7.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
