From 347de21eb76ed153098537e220ba00ff0d6756b6 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 11 Jul 2023 21:18:26 -0400 Subject: [PATCH] Steal docs from Cantera website --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2d9c840..f7ee239 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,41 @@ This repository hosts the recipe to build the Python interface for Cantera into # Cheatsheet -- To build packages locally for a development branch of Cantera, the following - commands can be used: +## Prerequisites + +- Create and activate a `conda` environment with `conda-build` installed + +## Default build + +The following instructions will build: +- The latest version of the `main` branch from https://github.com/Cantera/cantera +- For the version of Python installed in the ``base`` environment +- For some unspecified default version of NumPy + +```bash +git clone https://github.com/Cantera/conda-recipes +cd conda-recipes +conda build cantera +``` + +## Building for a different version of Python and NumPy + +```bash +conda build --python=X.Y --numpy=U.V ``` + +## Building for a local development branch of Cantera + +```bash export CANTERA_GIT=/path/to/cantera/repo export INCOMING_REF=branch-name-or-commit-hash conda build ./cantera conda build ./cantera-matlab ``` -- To build the MATLAB toolbox, you should set something like: -``` +## Building the MATLAB toolbox + +```bash export MW_HEADERS_DIR=/Applications/MATLAB_R2023a.app +conda build ./cantera-matlab ```