how_to.install_trouver

Instructions on installing trouver

Basic installation

Install Python. Note that trouver is currently (as of 12/24/2023) mostly tested on Python version 3.10.6.
Go to a command-line (e.g. cmd on Windows, Terminal on Linux, etc.) and run
```
python -m pip install trouver
```
or
```
pip install trouver
```

We recommend installing Obsidian.md to view, edit, and modify mathematical notes created by or which interact with trouver.
We recommend installing Jupyter to use notebooks to use the code from trouver. More specifically, we recommend installing JupyterLab via
```
pip install jupyterlab
```
and opening JupyterLab via
```
jupyter-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.

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 using nbdev. As such, nbdev Python library is required to effectively develop the source code and documentation of trouver. Install nbdev with
```
pip install nbdev
```
To install trouver from source, go to the cloned trouver folder in a terminal, and run
```
pip install -e '.[dev]'
```
See the nbdev tutorial page for more details on using nbdev.