Installation

pyTDGL
requires python
3.8
, 3.9
, or 3.10
. We recommend creating a new
conda environment
for pyTDGL
to avoid dependency conflicts with other packages. To create and activate a conda
environment called
tdgl
, run:
conda create --name tdgl python="3.10"
conda activate tdgl
Install via pip
From PyPI, the Python Package index:
pip install tdgl
From GitHub:
pip install git+https://github.com/loganbvh/py-tdgl.git
Editable installation
To install an editable version of pyTDGL
for development, run:
git clone https://github.com/loganbvh/py-tdgl.git
cd py-tdgl
pip install -e ".[dev,docs]"
See also
Verify the installation
To verify your installation by running the tdgl
test suite,
execute the following command in a terminal:
python -m tdgl.testing
If you prefer, you can instead run the following commands in a Python session:
>>> import tdgl.testing
>>> tdgl.testing.run()