README.md

Cantera Papers

This repository hosts the code for the Cantera papers application.

papers ingests DOIs of user-submitted papers where they used Cantera and produces a nicely formatted page listing each paper.

Dependency Management

We use conda-lock for dependency management. To update a dependency, edit environment.yml for dependencies of the main application, or dev-environment.yml for dependencies required to develop the application. After updating one of the files, run:

conda-lock lock -f environment.yml -f dev-environment.yml --mamba

This updates the conda-lock.yml file. Then run:

conda-lock install --name <your-environment-name> --mamba

Running the app locally

The app code is located in the app folder. To run the application, install the dependencies as above. Then start uvicorn from the root of the repository (not the app folder):

uvicorn app.main:app --reload

This runs the app object in the app.main module. The --reload flag causes uvicorn to watch the files in the app package and restart the server when changes are made.