Cantera Website

This repository contains the source code for the cantera.org website. The site is built using the Sphinx static site generator.

To build the website

Using pdm (Recommended)

1. Install pdm. Recommended method is to use pipx.

2. Run pdm install to create the virtual environment

3. Run pdm run build to build the website, or run pdm run rebuild to automatically rebuild the website when a page changes.

4. Run a web server to view the website:

   python -m http.server 8080 --directory build/html

5. Open a browser to http://localhost:8080

When you're ready to shut things down, close the web server with C-c (CTRL-c)

Using Conda (old instructions that aren't updated)

1. Create a virtual environment for Sphinx using conda and activate it. The environment must have Python 3.10 and the conda-lock package.

2. Clone the Cantera website source: git clone https://github.com/Cantera/cantera-website.git

3. Enter the website repo: cd cantera-website

4. Inside the website repo, install the required packages:

   conda-lock install continuous-integration/conda-lock.yml --name <name-of-your-environment>

5. Build the website and open in browser: make html && python -m http.server --directory build/html then navigate to localhost:8000 in your browser

6. Press C-c (CTRL-C) to close the Python HTTP server