From 56b78f039ec6e2d5481889d9ffbb751c6a236e3e Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Fri, 23 May 2025 05:13:49 -0500 Subject: [PATCH] Tweak community content --- source/citations.md | 33 +++++++++++++++++ source/community.md | 76 +++++--------------------------------- source/getting-involved.md | 51 ++++++++++++++++++++----- 3 files changed, 84 insertions(+), 76 deletions(-) create mode 100644 source/citations.md diff --git a/source/citations.md b/source/citations.md new file mode 100644 index 00000000..5c4be5fd --- /dev/null +++ b/source/citations.md @@ -0,0 +1,33 @@ +# Citing Cantera + +If you use Cantera in a publication, we would appreciate if you cited the version of +Cantera that you used. This helps to improve the reproducibility of your work, as well +as giving credit to the many +[authors](https://github.com/Cantera/cantera/blob/main/AUTHORS) who have contributed +their time to developing Cantera. The recommended citation for Cantera is as follows: + +:::{admonition} Cantera 3.1.0 +David G. Goodwin, Harry K. Moffat, Ingmar Schoegl, Raymond L. Speth, and Bryan W. Weber. +*Cantera: An object-oriented software toolkit for chemical kinetics, thermodynamics, and +transport processes*. , 2024. Version 3.1.0. +[doi:10.5281/zenodo.14455267](https://doi.org/10.5281/zenodo.14455267) +::: + +The following BibTeX entry may also be used: + +```bibtex +@misc{cantera, + author = "David G. Goodwin and Harry K. Moffat and Ingmar Schoegl and Raymond L. + Speth and Bryan W. Weber", + title = "Cantera: An Object-oriented Software Toolkit for Chemical + Kinetics, Thermodynamics, and Transport Processes", + year = 2024, + note = "Version 3.1.0", + howpublished = "\url{https://www.cantera.org}", + doi = {10.5281/zenodo.14455267} +} +``` + +If you are using a different version of Cantera, update the `year`, `note` and `doi` +fields accordingly. You can find the correct DOI for other versions of Cantera in +[Cantera's Zenodo Entry](https://doi.org/10.5281/zenodo.742000). diff --git a/source/community.md b/source/community.md index 79028ef4..cd4afb0f 100644 --- a/source/community.md +++ b/source/community.md @@ -1,6 +1,12 @@ # The Cantera Community -_Resources to help you participate in the community of Cantera users and developers_ +:::{admonition} Supporting Cantera +If you would like support the Cantera project, please check out our +{doc}`getting involved ` page. If you use Cantera in a publication, +we would appreciate if you {doc}`cited Cantera `. If you have found Cantera +to be useful to your research or company, please consider making a +[donation](sec-donations) to support our efforts. +::: ## About the Cantera Community @@ -93,6 +99,7 @@ please see the [Contributors' guide](https://github.com/Cantera/cantera/blob/mai for assistance in getting started. There are also plenty of current contributors who are happy to help, if you do not know how to get started. +(sec-bug-reporting)= ### Bug Reporting **What should I do if I think I've found a bug in Cantera?** @@ -118,78 +125,13 @@ happy to help, if you do not know how to get started. - The necessary *input* to generate the reported behavior - The full text of any error message you receive -## Supporting Cantera - -### Citing Cantera - -If you use Cantera in a publication, we would appreciate if you cited the version of -Cantera that you used. This helps to improve the reproducibility of your work, as well -as giving credit to the many [authors](https://github.com/Cantera/cantera/blob/main/AUTHORS) -who have contributed their time to developing Cantera. The recommended citation for -Cantera is as follows: - -> David G. Goodwin, Harry K. Moffat, Ingmar Schoegl, Raymond L. Speth, and Bryan W. -> Weber. *Cantera: An object-oriented software toolkit for chemical kinetics, -> thermodynamics, and transport processes*. , -> 2024. Version 3.1.0. doi:10.5281/zenodo.14455267 - -The following BibTeX entry may also be used: - -```bibtex -@misc{cantera, - author = "David G. Goodwin and Harry K. Moffat and Ingmar Schoegl and Raymond L. - Speth and Bryan W. Weber", - title = "Cantera: An Object-oriented Software Toolkit for Chemical - Kinetics, Thermodynamics, and Transport Processes", - year = 2024, - note = "Version 3.1.0", - howpublished = "\url{https://www.cantera.org}", - doi = {10.5281/zenodo.14455267} -} -``` - -If you are using a different version of Cantera, update the `year`, `note` and `doi` -fields accordingly. You can find the correct DOI for other versions of Cantera in -[Cantera's Zenodo Entry](https://doi.org/10.5281/zenodo.742000). - -### Donations - -Finally, please consider financially supporting Cantera's development! Cantera is a -fiscally sponsored project of NumFOCUS, a 501(c)3 nonprofit dedicated to supporting the -open source scientific computing community. If you have found Cantera to be useful to -your research or company, please consider making a -[donation](https://numfocus.org/donate-to-cantera) to support our efforts. All donations -will be used exclusively to fund the development of Cantera's source code, -documentation, or community. - -::::{grid} 1 2 2 2 - -:::{grid-item} -```{image} _static/img/SponsoredProject.png -:align: center -:alt: Powered by NumFOCUS -:target: https://numfocus.org -:width: 250px -``` -::: - -:::{grid-item} -```{button-link} https://numfocus.org/donate-to-cantera -:color: primary -:shadow: -:align: center -Donate to Cantera {octicon}`link-external` -``` -::: - -:::: - :::{toctree} :maxdepth: 1 :hidden: News Getting Involved +Citing Cantera Affiliated Packages Governance Dave Goodwin diff --git a/source/getting-involved.md b/source/getting-involved.md index e7e8cbbd..b2e3f8e5 100644 --- a/source/getting-involved.md +++ b/source/getting-involved.md @@ -8,33 +8,33 @@ fellow users. ## Ways to Contribute -- **Engage with the Community** +- **Engage with the Community.** Join the [Cantera Users’ Group](https://groups.google.com/g/cantera-users) to ask questions, share knowledge, and connect with other users and developers. -- **Contribute Code** +- **Contribute Code.** Explore our [open issues](https://github.com/Cantera/cantera/issues) and [feature requests](https://github.com/Cantera/enhancements/issues) to find tasks that match your interests. -- **Enhance Documentation** +- **Enhance Documentation.** Help us improve tutorials, examples, and API references to make Cantera more accessible to users of all levels. -- **Report and Fix Bugs** - Identify issues or bugs and contribute fixes to enhance the stability and performance - of Cantera. +- **Report and Fix Bugs.** + Identify [issues or bugs](sec-bug-reporting) and contribute fixes to enhance the + stability and performance of Cantera. ## Getting Started -- **Review the [Contributor's Guide](https://cantera.org/stable/develop/CONTRIBUTING.html)** +- **Review the [Contributor's Guide](https://cantera.org/stable/develop/CONTRIBUTING.html).** Learn about our development workflow, coding standards, and testing practices. -- **Set Up Your Development Environment** +- **Set Up Your Development Environment.** Follow our [development documentation](https://cantera.org/stable/develop/index.html) to compile Cantera from source and configure your tools. -- **Reach Out** +- **Reach Out.** If you're unsure where to start, contact the [core developers](mailto:developers@cantera.org) to discuss areas where you can contribute effectively. @@ -51,3 +51,36 @@ ensure a welcoming environment for everyone. Your contributions are valuable! If you make significant improvements, feel free to add your name to the `AUTHORS` file in your pull request. We appreciate and acknowledge the efforts of all our contributors. + +(sec-donations)= +## Donations + +Finally, please consider financially supporting Cantera's development! Cantera is a +fiscally sponsored project of NumFOCUS, a 501(c)3 nonprofit dedicated to supporting the +open source scientific computing community. If you have found Cantera to be useful to +your research or company, please consider making a +[donation](https://numfocus.org/donate-to-cantera) to support our efforts. All donations +will be used exclusively to fund the development of Cantera's source code, +documentation, or community. + +::::{grid} 1 2 2 2 + +:::{grid-item} +```{image} _static/img/SponsoredProject.png +:align: center +:alt: Powered by NumFOCUS +:target: https://numfocus.org +:width: 250px +``` +::: + +:::{grid-item} +```{button-link} https://numfocus.org/donate-to-cantera +:color: primary +:shadow: +:align: center +Donate to Cantera {octicon}`link-external` +``` +::: + +::::