From edfeb4934f0489859bd28cc14dab05f53f5f1598 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Sat, 23 Aug 2025 13:25:37 -0500 Subject: [PATCH 1/4] Clarify licensing and attribution --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dd16862..b105fc2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,18 @@ input files found here are based on scientific publications and are meant to dem Cantera's capabilities with more realistic and interesting reaction systems than those based only on the basic mechanisms provided in the main Cantera repository. +> [!IMPORTANT] +> **Licensing and Attribution Notice** +> +> The Cantera project is not the original author of the reaction mechanisms included +> in this repository and is not claiming to grant a license to them. The mechanisms +> were assembled by their respective researchers and appear to be shared without +> restrictive licensing requirements. +> +> **If you use this data in scientific publications, please cite the original papers** +> associated with each mechanism. Suitable citations are included in the `description` +> field of each mechanism file. + ## Adding files for new examples To implement an example requiring a new input file, the following steps should be @@ -29,4 +41,3 @@ followed: `cantera-example-data` can be merged. - Finally, the PR branch for the main repository can be updated to include the update of the `example_data` submodule, and this PR can be merged. - From afe7da4112e8591f29196f91b3b575331d4c499d Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Sat, 23 Aug 2025 13:27:03 -0500 Subject: [PATCH 2/4] Make file names consistent --- silicon_carbide.yaml => silicon-carbide.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename silicon_carbide.yaml => silicon-carbide.yaml (100%) diff --git a/silicon_carbide.yaml b/silicon-carbide.yaml similarity index 100% rename from silicon_carbide.yaml rename to silicon-carbide.yaml From f34523938247089fe07a097488f823ce86538bb7 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Sat, 23 Aug 2025 14:12:57 -0500 Subject: [PATCH 3/4] Clarify placement of CI hook --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b105fc2..6fb7f96 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,9 @@ followed: `example_data` submodule to this branch. - Commit the input file to a feature branch in the `example_data` submodule. - Create a pull request for your example in the main Cantera repository -- Create a pull request in the `cantera-example-data` repository which includes the text - `(Cantera/cantera#XYZ)` where `XYZ` is the number of your PR in the main repository. +- Create a pull request in the `cantera-example-data` repository which includes the + reference `Cantera/cantera#XYZ` in the title where `XYZ` is the number of your PR in + the main repository. * The CI process in the main repository will automatically check out this submodule PR so the new input file is available for those jobs that run the examples. * You should see one failing job, with the description `Linters / Check for unmerged From 0489ee2f34b849d63bae3ad7ea4469e319b48494 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Sat, 23 Aug 2025 16:18:41 -0500 Subject: [PATCH 4/4] Update/fix instructions in README.md --- README.md | 52 +++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6fb7f96..a79d6a8 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,52 @@ based only on the basic mechanisms provided in the main Cantera repository. > restrictive licensing requirements. > > **If you use this data in scientific publications, please cite the original papers** -> associated with each mechanism. Suitable citations are included in the `description` -> field of each mechanism file. +> associated with each mechanism. Suitable citations are usually included in the +> `description` field of each mechanism file. ## Adding files for new examples -To implement an example requiring a new input file, the following steps should be -followed: +To implement an example requiring a new input file, make sure to have forked both +`Cantera/cantera` and `Cantera/cantera-example-data` repositories. Steps outlined below +must use the local Git checkouts of your personal forks. +### Create example and input file(s) + +- Create a new feature branch in your personal fork of the `cantera` repository. - Create your new example in your local Git checkout of Cantera. -- Create the new input file in the `data/example_data` subdirectory. -- Commit the example to a new feature branch. - * :warning: Make sure you _do not_ add the input file or an update of the +- In the `data/example_data` subdirectory (a Git submodule), configure your fork of + `cantera-example-data` as a remote and create a feature branch for your input file(s). +- Create the new input file(s) in the `data/example_data` subdirectory. +- Verify that your example performs as expected locally. + +### Commit new files to your forks + +- From within the `data/example_data` subdirectory, commit the input file(s) to your + feature branch in your `cantera-example-data` repository. +- From the root folder, commit the example to your feature branch in your `cantera` + repository. + * :warning: Make sure you _do not_ add the input file(s) or an update of the `example_data` submodule to this branch. -- Commit the input file to a feature branch in the `example_data` submodule. -- Create a pull request for your example in the main Cantera repository -- Create a pull request in the `cantera-example-data` repository which includes the - reference `Cantera/cantera#XYZ` in the title where `XYZ` is the number of your PR in - the main repository. + +### Create pull requests on GitHub + +- Create a pull request for your example in the main `Cantera/cantera` repository. + * You should see multiple failing jobs. For new Python examples, descriptions start + with `CI / Run Python 3.XX examples on ubuntu-YY.ZZ` for tests with different + Python and ubuntu versions. For examples using other Cantera APIs, multiple other CI + jobs may fail. +- Create a pull request in the `Cantera/cantera-example-data` repository with the + reference `(Cantera/cantera#XYZ)` in the title, where `XYZ` is the + number of your PR in the main repository. +- Subsequent pushes to your feature branch on the main PR will result in the following: * The CI process in the main repository will automatically check out this submodule PR so the new input file is available for those jobs that run the examples. * You should see one failing job, with the description `Linters / Check for unmerged example-data pull request (pull_request)`. This is a reminder for maintainers for the remaining steps that need to be completed before merging the PR. -- Once PR reviews are completed and all expected tests pass, the PR on the - `cantera-example-data` can be merged. +- Once the PR review of the `cantera-example-data` branch is completed, it will be + merged by maintainers. - Finally, the PR branch for the main repository can be updated to include the update - of the `example_data` submodule, and this PR can be merged. + of the `example_data` submodule, which should be reset to the official Cantera + `cantera-example-data` repository. At this point, all CI jobs should pass. Once the + PR review is completed, the PR is ready to be merged.