Skip to content

PyPI_README.md

Latest commit

 

History

History
60 lines (39 loc) · 2.77 KB

PyPI_README.md

File metadata and controls

60 lines (39 loc) · 2.77 KB

Unit tests: Ubuntu Unit tests: macOS Regression test

Static analysis checks Sanitiser checks codecov

ASMC Prepare Decoding

Tool to compute decoding quantities.

This is a Python-wrapped C++ project with prebuilt CPython wheels targeting manylinux_2_28 on Linux and macOS 11.0+.

Platform \ CPython ≤3.8 3.9 3.10 3.11 3.12 3.13 3.14
Linux x86_64 ❌ ✅ ✅ ✅ ✅ ✅ ✅
Linux aarch64 ❌ ✅ ✅ ✅ ✅ ✅ ✅
macOS Intel (x86_64) ❌ ✅ ✅ ✅ ✅ ✅ ✅
macOS Apple Silicon (arm64) ❌ ✅ ✅ ✅ ✅ ✅ ✅

Quickstart

Install the Python package from PyPI

Most functionality is available through a Python package which can be installed with:

pip install asmc-preparedecoding

Example notebook

Examples for using the Python package can be found in the following Jupyter notebook:

Please note that to run the notebook you should first clone the repository and install Jupyter:

git clone https://github.com/PalamaraLab/PrepareDecoding.git
cd PrepareDecoding

pip install jupyter
jupyter-notebook notebooks/CreatingDecodingQuantities.ipynb

API documentation

A description of the API can be found here:

File formats

Descriptions of the file formats used can be found here:

License

This project is currently released under the GNU General Public License Version 3.