Installation Guide#
It is recommended to use a virtualised Python environment in most settings. The package can be easily installed using pip. The base requirements of the package are kept to a minimum to reduce the likelihood of conflicts. This project relies on a relatively recent version of pip, so you might need to upgrade pip within your virtual environment. If this is required, the installation process will automatically prompt you to do so, including the commands required. This is a simple and reliable step which will apply onto to your virtual environment.
The basic installation includes only the most essential requirements, so as to not require users to include many complex dependencies.
There are 5 different types of environments which can be installed in scores
:
core: only contains mathematical functions
tutorial: includes jupyter lab and ability to run all the notebooks
development: includes pylint, black and other development tools
all: includes requirements for core, tutorial and development, but excludes maintainer requirements
maintainer: includes tools for building the documentation and building for PyPI
1. Core Environment#
Installs:
scores
packageOnly the required core dependencies, nothing extra, no tutorials
NOTE: Use this environment if you are unsure about what package you require.
from PyPI#
pip install scores
from local git repository#
pip install .
2. Tutorial Environment#
Installs:
core dependencies
Dependencies for running the tutorial notebooks with jupyter lab
PyPI#
pip install scores[tutorial]
Local git repository#
pip install .[tutorial]
3. Development Environment#
Installs:
core dependencies
Dependencies for development on the git repository
i.e running tests suite, linters, etc
PyPI#
pip install scores[dev]
Local git repository#
pip install .[dev]
4. All Non-Maintainer Dependencies#
Installs:
core dependencies
development dependencies
tutorial dependencies
From PyPI#
pip install scores[all]
Local git repository#
pip install .[all]
5. Maintainer Environment#
Installs:
core dependencies
Dependencies for building new versions of the
scores
packageDependencies for building the documentation as HTML
PyPI#
pip install scores[maintainer]
Local git repository#
pip install .[maintainer]