Installing MusicBox

MusicBox is made pip installable. As with any other Python package, we recommend the use of MusicBox within a virtual environment to contain dependencies. This page provides instructions on setting up this environment with conda.

Creating a Virtual environment (conda)

After installing conda, create a new conda environment with a minimum Python version of 3.9, and activate your new environment:

$ conda create --name musicbox python=<minimum-3.9> --yes
$ conda activate musicbox

Pip

Within your new conda environment, install MusicBox via pip:

$ pip install acom_music_box

Note that this step can also be performed without a virtual environment if a local installation is acceptable.

Verifying installation

To verify that MusicBox was installed, run the following command within your conda environment:

$ conda list

This should print a list of all available packages within your conda environment, one of which should be acom_music_box with the version listing matching the latest release as listed on our Github.

If you’ve chosen to install MusicBox locally, the following command will function in the same manner:

$ pip list

With MusicBox successfully installed, you should be able to import the package from a Python shell or script and print the version. Note that the full package name is acom_music_box:

import acom_music_box; print(acom_music_box.__version__)

Developer installation

For users that want to modify or contribute to MusicBox, please follow the editable installation instructions on the Contributing page.