1. Installation

The spectrally-regularised-LVMs package has been coded in Python3 and has been tested on Linux and Windows operating systems. The package was originally written on a system that uses Windows, but makes use of the os.path module to ensure that any differences between operating system’s is accounted for if anything is stored in a user’s directory.

The package can either be installed via the PyPi package installer pip, or by cloning the repository, creating a local Poetry environment, and then installing the package in development mode via Poetry.

1.1. Pip installation

To use spectrally-regularised-LVMs within your local environment, the package can be installed using pip.

(.venv) $ pip install spectrally-regularised-lvms

1.2. Cloning from Github

You can clone the GitHub repository using git. It is recommended here that you first create a local Poetry environment

$ poetry init

More details on setting up a local Poetry evironment can be found here. Then, the package can be cloned from Github using git.

$ git clone git@github.com:RyanBalshaw/spectrally-regularised-LVMs.git

The repository can then be installed in the Poetry environment by using Poetry’s add command.

$ poetry add ./spectrally-regularised-LVMs/
$ poetry add --editable ./spectrally-regularised-LVMs/

Equivalently, the git clone step can be bypassed by directly referencing the Github repository when adding the dependency to the Poetry environment.

$ poetry add git+ssh://github.com/RyanBalshaw/spectrally-regularised-LVMs.git
$ poetry add --editable git+ssh://github.com/RyanBalshaw/spectrally-regularised-LVMs.git

The --editable option can be used if you wish to install the package in editable mode. Alternatively, you can specify the dependency in the pyproject.toml file for your project.

[tool.poetry.dependencies]
my-package = {path = "../my/path", develop = true}