⚒️ Installation#
Prerequisites#
Basic Installation#
WaveSongs is available at Pypi. To install the latest stable version, run:
pip install wavesongs
Tip: create a dedicated Python environment
It is possible to use pip to install wavesongs outside of a virtual environment, but this is not recommended. Virtual environments create an isolated Python environment that does not interfere with your system’s existing Python installation. They can be easily removed and contain only the specific package versions your application requires. Additionally, they help avoid a common issue known as “dependency hell”, where conflicting package versions cause problems and unexpected behaviors.
It is highly recommended that you create a new virtual environment. This can be done in two ways, but you only need to choose one:
Python virtual environments
You can set the name you prefer, however, a good practice is to name the environment as
envor.env.python -m venv .venv source .venv/bin/activate
python -m venv .venv .\.venv\Scripts\activate
Conda environments
conda create -n wavesongs-env python=3.12 pip conda activate wavesongs-env
Developer Installation#
First, create a Python environment as mentioned in tip. Then, to install the latest deveopment version from source clone the main repository from GitHub
git clone https://github.com/wavesongs/wavesongs
cd wavesongs # enter the cloned directory
Install the required dependencies
pip install -r requirements.txt
You can see all the required libraries in the requirements.txt file or in the pyproject.toml file.
Finally, install WaveSongs in editable mode
pip install -e .
Note
It is highly recommended to use Jupyter notebooks for an interactive development experience. However, Python and IPython terminals are also supported and can be used effectively.
OS Support#
WaveSongs is developed and tested on Linux. It should also work on macOS and Windows. If you encounter a prooblem, please let us know by opening an issue or a pull request.