Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.37 KB

INSTALL.md

File metadata and controls

39 lines (27 loc) · 1.37 KB

Installation

Though it is not generally required we strongly encourage you to use a conda environment for setting up this software, especially as it is currently under active development and dependencies might change rapidly which could conflict with other installed python packages.

To do this follow the guide over on the conda homepage here (a miniconda installation will be sufficient). After you installed conda you can create a conda environment like follows (we currently test our software against Python 3.11):

conda create --name hmsm python=3.11

And activate it with:

conda activate hmsm

Now you can install our package, either directly from Github via pip by running the following:

pip install git+https://github.com/digital-organology/hmsm.git

Alternativelys you could downlaod the repository as a zip archive from the Github page and then executing the following commands (assuming you are in the directory where the downloaded zip file lives):

unzip hmsm-main.zip
cd hmsm-main
pip install .

Pip should automatically take care of installing all dependencies for you and you should now be set up to start using the software. To test it you can run:

disc2midi --help

This should output some help about the command line parameters of the disc midification script.