User-friendly tools for applied topology in Python
Project description
Open Applied Topology
Open applied topology (OAT) is a library for fast, user-friendly algebra and topology. OAT has
- a user-friendly frontend for Python users, called oat_python
- a fast backend written in Rust, called oat_rust
- a variety of tutorials published as jupyter notebooks
This package contains the source code for oat_python.
Install and explore
Python users Install oat_python through PyPI, e.g. pip install oat_python
, conda_install oat_python
, etc.). Explore the Jupyter notebook tutorials on GitHub!
Developers Everyone is a developer, and everyone is invited to modify and extend the source code for this package! oat_python is a combination of Rust and Python code. We developed oat_python using PyO3
and maturin
. To download and modify oat_python, then install and use the modified version, check out the instructions for Python Installation from source, below.
Documentation
Documentation for OAT-Python is currently under development.
Python users The best resources currently available are
- Jupyter notebook tutorials on GitHub
- Docstrings available through Python's
help()
function.
Rust Developers If you are interested in modifying the Rust code in OAT-Python, see the API documenation for oat_python available at Crates.io. You may also find it helpful to explore the documenation for PyO3 and Maturin, which are the packages used to link Rust and Python.
Python Developers Documentation for the Python API is not available at this time (we are working to address this). In the meantime we have done our best to document the code with docstrings, and encourage you to check out the source code directly.
Contributing
For information on contributing, see CONTRIBUTING
.
License
For inforamtion on copyright and licensing, see LICENSE
.
Attributions
OAT is an extension of the ExHACT library. See ATTRIBUTIONS.md
for details.
Python Installation from source
-
Download and install the most recent version of Rust. Make sure your installation is up to date by running
rustup update
in a command shell. -
Create a virtual Python environment, e.g. using Anaconda, or open one that you already have. In this example, let's assume the environment name is
myenv
. Activatemyenv
, and runpip install maturin
A number of warning messages may appear; this is normal.
If you already have maturin installed, make sure it is up to date!
-
With
myenv
activated, CD into the oat_python folder, and runmaturin develop --release
-
OAT-Python should now be installed. Try running the Jupyter notebooks with
myenv
!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for oat_python-0.1.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c901cc1439456e900fb80fb587e900e66f1e4889abb891f742961ab686623054 |
|
MD5 | f8ae4fd535a0508d059d3b18621e36b0 |
|
BLAKE2b-256 | 8b9e0dbcb9959f310af67c55331727a944783786a9533257a9e29944027c46e4 |