Installation#

MCR-NMF can be installed using either pip or conda. Both methods will install the package along with its dependencies.

With conda#

To install via conda from the conda-forge channel:

conda install -c conda-forge mcrnmf

With pip#

To install the latest release from PyPI:

pip install mcrnmf

Note

macOS Apple Silicon (M4) users: When running the McrNmf package installed via pip, you may encounter runtime numerical warnings (e.g., divide/overflow). To avoid these, please install via conda-forge.

From Source#

To install from the latest source:

git clone https://github.com/siddarthVasudevan/mcrnmf.git
cd mcrnmf
pip install .

Requirements#

The package requires the following:

  • Python ≥ 3.11.9, < 3.14

  • NumPy ≥ 1.24, < 2.3

  • Numba ≥ 0.61.2

Note

It is recommended to install in a clean virtual environment (via venv or conda) to avoid dependency conflicts.