Getting started

MATLAB

Dependencies

  • MATLAB ≥R2024a
  • kneighbor: Statistics and Machine Learning Toolbox (if method="indirect")
  • mumap: Manopt (if solver="trustregions") or Deep Learning Toolbox (if solver="adam")
  • mumap: Parallel Computing Toolbox (if gpu=true)

Simple installation

Add ./abct-matlab/abct to your MATLAB path.

addpath('./abct-matlab/abct')

Package installation

Install using the MATLAB Package Manager.

mpminstall("./abct-matlab/abct")

Usage

Basic usage:

[output1, output2, ...] = function_name(input1, input2, ..., name=value)

See the individual function pages for more details.

See the individual examples for example usage (in Python).

Python

Dependencies

  • Python ≥3.11
  • numpy
  • scipy
  • igraph
  • pytorch
  • pymanopt
  • pynndescent
  • pydantic

Direct installation

Download the latest release and install using pip.

pip install ./abct-python

Pypi installation

Install directly from pypi (may not be the latest release).

pip install abct

Usage

Basic usage:

import abct
output1, output2, ... = abct.function_name(input1, input2, ..., name=value)

See the individual function pages for more details.

See the individual examples for example usage.