(tools/software)=
# Software used by QuantEcon

The following details the software that is used directly by `QuantEcon`
and how to install it.

## Jupyter Book

[Jupyter Book](https://jupyterbook.org/intro.html) provides a command line tool to build Jupyter Books and is maintained
by the [Executable Book Project](https://executablebooks.org). This is the `EBP` equivalent of `jupinx`.

To install:

```bash
pip install "jupyter-book==1.*"
```

```{warning}
An unpinned `pip install jupyter-book` now installs **v2.x**, which is built on the new
MyST engine and is a different tool from the v1 documented across this manual and used
to build the lecture series. Pin to `1.*` until the org migrates.
```

More information is available at the [repo](https://github.com/executablebooks/jupyter-book)

## QuantEcon Book Theme

The QuantEcon book theme is a jupyter-book theme maintained by [QuantEcon](https://quantecon.org)

It is now published on [PyPI](https://pypi.org/project/quantecon-book-theme/), so to install:

```bash
pip install quantecon-book-theme
```

```{note}
The shared {ref}`quantecon environment <quantecon-environment>` pins a specific version of
`quantecon-book-theme` (along with the other build dependencies) to ensure consistent `html` output across
projects. Refer to that `environment.yml` for the exact versions in use.
```

```{seealso}
This is one of three themes QuantEcon maintains — see {ref}`Website themes <tools:themes>`
for what each one is for, including the MyST theme for Jupyter Book 2.
```

## Jupytext

[Jupytext](https://jupytext.readthedocs.io/en/latest/) is useful for converting between `ipynb` and `md` files or vice-versa. `Myst` markdown
has a two-way mapping available so we can easily move between both formats.

To install:

```bash
pip install jupytext
```

## ghp-import

[ghp-import](https://pypi.org/project/ghp-import/) is a tool to **force** update github pages from local builds.

To install:

```bash
pip install ghp-import
```