OpenPlains Learning

Local Project Setup

clone the forked repository

Mac/Linux

git clone YOUR_FORKED_REPO_URL

# create a virtual environment
python3 -m venv venv
# activate the virtual environment
source venv/bin/activate

# install dependencies
pip install -r requirements.txt

Windows

# Create a virtual environment
py -m venv env

# Activate the virtual environment
env\Scripts\activate.bat

# Install dependencies
py -m pip install -r requirements.txt

Notebooks

The notebooks are located in the notebooks directory.

Quarto Website

To preview the website locally, run the following command:

quarto preview

Publishing the Website

The website is pubished to GitHub Pages when you commit to the main branch.

Author

Corey T. White