Estimated reading time: 3 minutes
Note
tephpy has not had its first release yet, so the commands in Stable do
not work today. They are what installing will look like from v0.1.0
onward. To use tephpy now, take the Latest or Developer route.
The latest stable release, from conda-forge or PyPI:
$ conda create --name myenv --channel conda-forge tephpy
$ conda activate myenv
conda
installation
instructions.
$ pip install tephpy
pip
installation
instructions.
$ pixi init myenv
$ cd myenv
$ pixi add tephpy
pixi
installation
instructions.
$ uv venv
$ source .venv/bin/activate
$ uv pip install tephpy
uv
installation
instructions.
The development version, from the main branch:
$ conda create --name myenv --channel conda-forge pip
$ conda activate myenv
$ pip install git+https://github.com/bjlittle/tephpy.git@main
$ pip install git+https://github.com/bjlittle/tephpy.git@main
$ pixi init myenv
$ cd myenv
$ pixi add python
$ pixi add --pypi "tephpy @ git+https://github.com/bjlittle/tephpy.git@main"
$ uv venv
$ source .venv/bin/activate
$ uv pip install "tephpy @ git+https://github.com/bjlittle/tephpy.git@main"
To work on tephpy itself, clone the repository:
$ git clone git@github.com:bjlittle/tephpy.git
$ cd tephpy
tephpy develops with pixi, which reads its environments
from pyproject.toml and needs no setup of its own:
$ pixi run tests
$ pixi run lint
$ pixi run docs
Those three are the checks a pull request must pass, and each builds the
environment it needs the first time it runs. pixi run docs builds this
documentation and runs every gate over the result.
If you would rather not use pixi, the same dependencies are declared as
extras:
$ conda create --name tephpy-dev --channel conda-forge python pip
$ conda activate tephpy-dev
$ pip install --editable ".[devs,docs,test]"
$ pip install --editable ".[devs,docs,test]"
$ pixi shell --environment devs
$ uv venv
$ source .venv/bin/activate
$ uv pip install --editable ".[devs,docs,test]"