Skip to main content

steenroder: A Python package for the computation of persistence Steenrod barcodes

The widespread use in applied topology of the barcode of filtered cellular complexes rests on a balance between discriminatory power and computability. It has long been envision that the strength of this invariant could be increase using cohomology operations. This package computes the recently defined Sqk-barcodes which have been shown to effectively increase the discriminatory power of barcodes on real-world data.

For a complete presentation of these invariants please consult Persistence Steenrod modules by U. Lupo, A. Medina-Mardones and G. Tauzin.

License

steenroder is distributed under the MIT license.

Documentation

Please visit https://steenroder.github.io/steenroder/ and navigate to the version you are interested in.

A number of tutorial notebooks are available in notebooks/. Example notebooks that reproduce the case studies explored in the paper are available in notebooks/examples/.

Installation

Dependencies

The latest stable version of steenroder requires:

  • python (>= 3.8)

  • numpy (>= 1.19.1)

  • numba (>= 0.53.0)

  • psutils (>= 5.8.0)

  • gudhi (>= 3.5.0)

  • plotly (>= 5.3.1)

To run the examples, jupyter is required.

Installation

The simplest way to install steenroder is using pip

python -m pip install -U steenroder

If necessary, this will also automatically install all the above dependencies. Note: we recommend upgrading pip to a recent version as the above may fail on very old versions.

Contributing

We welcome new contributors of all experience levels. The Steenroder community goals are to be helpful, welcoming, and effective. To learn more about making a contribution to steenroder, please consult the relevant page.

Testing

After developer installation, you can launch the test suite from outside the source directory:

pytest steenroder

Citing steenroder

If you use steenroder in a scientific publication, we would appreciate citations to the following paper:

Persistence Steenrod modules

You can use the following BibTeX entry:

@article{steenroder,
   author = {{Lupo}, Umberto and {Medina-Mardones}, Anibal M. and {Tauzin}, Guillaume},
   title = "{Persistence Steenrod modules}",
   journal = {Journal of Applied and Computational Topology},
   year = {2022},
   doi = {10.1007/s41468-022-00093-7},
   URL = {https://doi.org/10.1007/s41468-022-00093-7}
}

Contacts

steenroder@gmail.com

Metadata

Release files for steenroder 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for steenroder 0.1.0
File Size Uploaded
steenroder-0.1.0.tar.gz 17.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for steenroder 0.1.0
File Interpreter ABI Platform
steenroder-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 33.5 kB

Release files / steenroder-0.1.0.tar.gz

Download URL steenroder-0.1.0.tar.gz
Size 17.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9ac5bc6d7f738efe57598467f7fdd65df1dd7be0f5fc644daa25c3e20cb0620b
BLAKE2b-256 checksum
How to use checksums
4c9caa5214fb8e834b6288179b0327ddf42e1590a69c6cfff93660ad496e5d62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Release files / steenroder-0.1.0-py3-none-any.whl

Download URL steenroder-0.1.0-py3-none-any.whl
Size 16.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f9b44d6ab56ced30d1d962b524f07e0f687a6ae069e1683baa36f2a9558de20
BLAKE2b-256 checksum
How to use checksums
fe8229edb65967ef374628da10af0bce55725798bf3b9635a9e44b2cd92679d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page