Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.6 KB

PyPI_README.md

File metadata and controls

55 lines (36 loc) · 2.6 KB
Raw

Unit tests: Windows Unit tests: Ubuntu Unit tests: macOS Regression test

Static analysis checks Sanitiser checks codecov BCH compliance

ASMC Prepare Decoding

Tool to compute decoding quantities.

Quickstart

Install the Python module from PyPI

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

pip install asmc-preparedecoding

This Python module is currently available on Linux and macOS. We hope it will be available soon on Windows.

Example notebook

Examples for using the Python module 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.