Ctrl+K

Installation

1. Installation#

1.1. Installation instructions#

Reflectorch can be installed directly from the Python Packaging Index (PyPI) via the Python package installer pip:

pip install reflectorch

Additionally, one can clone the entire Github repository and install the package in editable mode:

git clone https://github.com/schreiber-lab/reflectorch.git
pip install -e .

For development purposes, the package can be installed together with the optional dependencies for building the distribution, testing and documentation:

git clone https://github.com/schreiber-lab/reflectorch.git
pip install -e .[tests,docs,build]

1.1.1. GPU support#

The CPU version of Pytorch is installed automatically with the package. Users with Nvidia GPUs need to additionally install Pytorch with CUDA support corresponding to their hardware and operating system according to the official installation guide from the Pytorch website.

1.2. Package dependencies#

The package was tested for Python versions which are 3.7 or newer. The package has the following core dependencies, which are listed in pyproject.toml and installed automatically together with the package.

  • numpy

  • torch

  • scipy

  • tqdm

  • PyYAML

  • click

  • matplotlib

  • ipywidgets

  • huggingface_hub

  • safetensors

Contents