Crate oat_python

source
Expand description

Open applied topology (OAT) is a library for fast, user-friendly algebra and topology. OAT has

This package contains the source code for oat_python.

§Contents

§Welcome!

Welcome! This package is oat_python, part of the Open Applied Topology ecosystem. It provides powerful tools for applied topology, including

  • Persistent homology
  • Simplicial complexes
  • Homological algebra
  • Cycle optimization
  • Interactive 2d and 3d visualization

§Community

OAT is by and for the open source community. Reach out to the developers at openappliedtopology@gmail.com if you

  • Need help getting started
  • Wish for a missing feature
  • Want to try coding

A collaboration of 20 research centers at colleges, universities, private, and public organizations support OAT’s development. The founding developers are Princton University, Macalester College, and the University of Delaware The National Science Foundation granted seed funding for OAT in 2019 under the ExHACT project, and Pacific Northwest National Laboratory (PNNL) provides continuing financial support. PNNL now coordinates development. See here for further details.

§Values

Our shared values are

  • Inclusion
  • Respect, and
  • A shared passion to expand human knowledge, through algebraic topology

§Mission

Performance

OAT is a first-class solver for cutting-edge applications. It is ideally suited to large, sparse data sets. The core library is written in Rust, a low-level systems programming language designed for safety and performance. High-level wrappers are available in Python.

Reliability

OAT has more unit tests than type definitions and function definitions, combined. Its modular design enables end users to write their own checks for correctness, with ease. The library inherits strong safety guarantees from the the Rust compiler.

Transparency

OAT documentation emphasizes clarity and accessibility for users with all backgrounds. It includes more than 180 working examples, and describes both code and underlying mathematical concepts in detail. Online Jupyter notebook tutorials illustrate how to combine multiple tools into larger applications. The platform’s modular design breaks large solvers into basic components, which it exposes to the user for inspection. In addition, the library provides powerful methods to inspect and analyze objects, consistent with the way humans naturally think about problems; for example, you can look up rows and columns of boundary matrices using cubes, simplices, or cells as keys.

Modularity

OAT reduces complex problems to the same basic building blocks that topologists use when writing on a chalk board. Users can mix and match those blocks with confidence, using a simple, streamlined interface. They can even create new components that work seemlessly with the rest of the library, including coefficient rings, sparse matrix data structures, and customized filtrations on simplicial complexes.

§Get Started

The oat_python package is written in Rust and Python. This is the documentation page for the Rust API, which you can explore by making selections either from the menu on the left or from the list of modules below.

Python users and new developers: see README.md on the package GitHub repository for tips to get started!

Modules§