QuantEcon Operations Manual

This is the QuantEcon operations manual and userguide.

It documents QuantEcon operations and provides a single point of reference for understanding how infrastructure is setup and maintained to support the day to day operations of the project.

It provides more opinionated suggested workflows compared to the standard documentation provided by projects such as jupyter-book

Note

This manual includes automated preview builds for Pull Requests. When you submit changes, a preview of the updated documentation will be automatically built and made available for review before merging.

Warning

When updating this site please do not add any credential data or private information. This repository powers a public facing website to improve accessibility

For these items please use the wiki

The quantecon environment

There is a environment.yml file available to setup a general anaconda environment that can be used to build all quantecon projects.

Tip

If you are using an Apple running on arm64 such as the M1 or M2 you will need the following additional steps before setting up your environment.

1. Ensure you install the M1 version of Anaconda Python.

2. Install homebrew to install some binary packages

3. Run

   brew install cbc pkg-config
   

To use it:

1. Download the environment.yml file

2. Use conda to build the environment using:

   conda env create -f environment.yml
   

3. Activate the evironment using:

   conda activate quantecon
   

Tip

If you already have a quantecon environment you can remove it using:

conda env remove -n quantecon

and then reinstall a fresh environment.

It is also possible to update your quantecon environment using:

conda env update --file environment.yml  --prune

with further info in the conda docs