how_to.install_trouver
trouver
Basic installation
Install Python. Note that
trouver
is currently (as of 4/3/2023) mostly tested on Python version 3.10.6.Go to a command-line (e.g.
cmd
on Windows,Terminal
on Linux, etc.) and runpython -m pip install trouver
or
pip install trouver
Recommended additional installations
We recommend installing
Obsidian.md
to view, edit, and modify mathematical notes created by or which interact withtrouver
.We recommend installing
Jupyter
to use notebooks to use the code fromtrouver
. More specifically, we recommend installingJupyterLab
viapip install jupyterlab
and opening
JupyterLab
viajupyter-lab
or installing the classic Jupyter Notebook via
pip install notebook
and opening the notebook via
jupyter notebook
Alternatively, we also recommend using notebooks via
Visual Studio Code
.
For Developers/Install from source
To use or develop the source code or documentation of trouver
,
clone the
trouver
GitHub repository. See GitHub’s instructions on cloning a repository for instance.trouver
is developed usingnbdev
. As such,nbdev
Python library is required to effectively develop the source code and documentation oftrouver
. Installnbdev
withpip install nbdev
To install
trouver
from source, go to the clonedtrouver
folder in a terminal, and runpip install -e '.[dev]'
See the
nbdev
tutorial page for more details on usingnbdev
.