Skip to content

Installation

General use

Most users will simply want to install the most recent, stable release for general use.

That's nice and easy:

pip install amads

Development

To install the project for development (with full git commit history etc.) things are, of course, slightly more involved.

Prerequisites

  • Python 3.10 or higher
  • Git

Installation Steps

  1. Clone the repository:
git clone https://github.com/music-computing/amads.git
cd toolkit
  1. Create and activate a virtual environment:
# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate
  1. Install the package in editable mode:
# Basic installation
pip install -e .

# If you plan to contribute to the codebase
pip install -e ".[dev]"
pre-commit install

Your installation is now complete! The package is installed in editable mode, which means any changes you make to the source code will be reflected immediately without needing to reinstall.

Note: If you plan to build the documentation or contribute to development, use the second installation command with [dev] which includes additional dependencies like mkdocs and other documentation tools.