Skip to content

Installation

Requirements

  • Python 3.10 or later
  • steer-core (installed automatically)

From PyPI

pip install steer-materials

From source

Clone the repository and install in editable mode:

git clone https://github.com/stanford-developers/steer-materials.git
cd steer-materials
pip install -e .

Optional extras

Install development tools (testing, linting, formatting):

pip install -e ".[dev]"

Install documentation tools:

pip install -e ".[docs]"

Verify the installation

import steer_materials
print(steer_materials.__version__)