Skip to content

Commit ec2d732

Browse files
ischoeglspeth
authored andcommitted
Tweak community content
1 parent d5bc277 commit ec2d732

File tree

3 files changed

+84
-76
lines changed

3 files changed

+84
-76
lines changed

source/citations.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Citing Cantera
2+
3+
If you use Cantera in a publication, we would appreciate if you cited the version of
4+
Cantera that you used. This helps to improve the reproducibility of your work, as well
5+
as giving credit to the many
6+
[authors](https://github.com/Cantera/cantera/blob/main/AUTHORS) who have contributed
7+
their time to developing Cantera. The recommended citation for Cantera is as follows:
8+
9+
:::{admonition} Cantera 3.1.0
10+
David G. Goodwin, Harry K. Moffat, Ingmar Schoegl, Raymond L. Speth, and Bryan W. Weber.
11+
*Cantera: An object-oriented software toolkit for chemical kinetics, thermodynamics, and
12+
transport processes*. <https://www.cantera.org>, 2024. Version 3.1.0.
13+
[doi:10.5281/zenodo.14455267](https://doi.org/10.5281/zenodo.14455267)
14+
:::
15+
16+
The following BibTeX entry may also be used:
17+
18+
```bibtex
19+
@misc{cantera,
20+
author = "David G. Goodwin and Harry K. Moffat and Ingmar Schoegl and Raymond L.
21+
Speth and Bryan W. Weber",
22+
title = "Cantera: An Object-oriented Software Toolkit for Chemical
23+
Kinetics, Thermodynamics, and Transport Processes",
24+
year = 2024,
25+
note = "Version 3.1.0",
26+
howpublished = "\url{https://www.cantera.org}",
27+
doi = {10.5281/zenodo.14455267}
28+
}
29+
```
30+
31+
If you are using a different version of Cantera, update the `year`, `note` and `doi`
32+
fields accordingly. You can find the correct DOI for other versions of Cantera in
33+
[Cantera's Zenodo Entry](https://doi.org/10.5281/zenodo.742000).

source/community.md

Lines changed: 9 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# The Cantera Community
22

3-
_Resources to help you participate in the community of Cantera users and developers_
3+
:::{admonition} Supporting Cantera
4+
If you would like support the Cantera project, please check out our
5+
{doc}`getting involved <getting-involved>` page. If you use Cantera in a publication,
6+
we would appreciate if you {doc}`cited Cantera <citations>`. If you have found Cantera
7+
to be useful to your research or company, please consider making a
8+
[donation](sec-donations) to support our efforts.
9+
:::
410

511
## About the Cantera Community
612

@@ -93,6 +99,7 @@ please see the [Contributors' guide](https://github.com/Cantera/cantera/blob/mai
9399
for assistance in getting started. There are also plenty of current contributors who are
94100
happy to help, if you do not know how to get started.
95101

102+
(sec-bug-reporting)=
96103
### Bug Reporting
97104

98105
**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.
118125
- The necessary *input* to generate the reported behavior
119126
- The full text of any error message you receive
120127

121-
## Supporting Cantera
122-
123-
### Citing Cantera
124-
125-
If you use Cantera in a publication, we would appreciate if you cited the version of
126-
Cantera that you used. This helps to improve the reproducibility of your work, as well
127-
as giving credit to the many [authors](https://github.com/Cantera/cantera/blob/main/AUTHORS)
128-
who have contributed their time to developing Cantera. The recommended citation for
129-
Cantera is as follows:
130-
131-
> David G. Goodwin, Harry K. Moffat, Ingmar Schoegl, Raymond L. Speth, and Bryan W.
132-
> Weber. *Cantera: An object-oriented software toolkit for chemical kinetics,
133-
> thermodynamics, and transport processes*. <https://www.cantera.org>,
134-
> 2024. Version 3.1.0. doi:10.5281/zenodo.14455267
135-
136-
The following BibTeX entry may also be used:
137-
138-
```bibtex
139-
@misc{cantera,
140-
author = "David G. Goodwin and Harry K. Moffat and Ingmar Schoegl and Raymond L.
141-
Speth and Bryan W. Weber",
142-
title = "Cantera: An Object-oriented Software Toolkit for Chemical
143-
Kinetics, Thermodynamics, and Transport Processes",
144-
year = 2024,
145-
note = "Version 3.1.0",
146-
howpublished = "\url{https://www.cantera.org}",
147-
doi = {10.5281/zenodo.14455267}
148-
}
149-
```
150-
151-
If you are using a different version of Cantera, update the `year`, `note` and `doi`
152-
fields accordingly. You can find the correct DOI for other versions of Cantera in
153-
[Cantera's Zenodo Entry](https://doi.org/10.5281/zenodo.742000).
154-
155-
### Donations
156-
157-
Finally, please consider financially supporting Cantera's development! Cantera is a
158-
fiscally sponsored project of NumFOCUS, a 501(c)3 nonprofit dedicated to supporting the
159-
open source scientific computing community. If you have found Cantera to be useful to
160-
your research or company, please consider making a
161-
[donation](https://numfocus.org/donate-to-cantera) to support our efforts. All donations
162-
will be used exclusively to fund the development of Cantera's source code,
163-
documentation, or community.
164-
165-
::::{grid} 1 2 2 2
166-
167-
:::{grid-item}
168-
```{image} _static/img/SponsoredProject.png
169-
:align: center
170-
:alt: Powered by NumFOCUS
171-
:target: https://numfocus.org
172-
:width: 250px
173-
```
174-
:::
175-
176-
:::{grid-item}
177-
```{button-link} https://numfocus.org/donate-to-cantera
178-
:color: primary
179-
:shadow:
180-
:align: center
181-
Donate to Cantera {octicon}`link-external`
182-
```
183-
:::
184-
185-
::::
186-
187128
:::{toctree}
188129
:maxdepth: 1
189130
:hidden:
190131

191132
News <news-index>
192133
Getting Involved <getting-involved>
134+
Citing Cantera <citations>
193135
Affiliated Packages <affiliated>
194136
Governance <governance>
195137
Dave Goodwin <dave-goodwin>

source/getting-involved.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ fellow users.
88

99
## Ways to Contribute
1010

11-
- **Engage with the Community**
11+
- **Engage with the Community.**
1212
Join the [Cantera Users’ Group](https://groups.google.com/g/cantera-users) to ask
1313
questions, share knowledge, and connect with other users and developers.
1414

15-
- **Contribute Code**
15+
- **Contribute Code.**
1616
Explore our [open issues](https://github.com/Cantera/cantera/issues) and
1717
[feature requests](https://github.com/Cantera/enhancements/issues) to find tasks that
1818
match your interests.
1919

20-
- **Enhance Documentation**
20+
- **Enhance Documentation.**
2121
Help us improve tutorials, examples, and API references to make Cantera more
2222
accessible to users of all levels.
2323

24-
- **Report and Fix Bugs**
25-
Identify issues or bugs and contribute fixes to enhance the stability and performance
26-
of Cantera.
24+
- **Report and Fix Bugs.**
25+
Identify [issues or bugs](sec-bug-reporting) and contribute fixes to enhance the
26+
stability and performance of Cantera.
2727

2828
## Getting Started
2929

30-
- **Review the [Contributor's Guide](https://cantera.org/stable/develop/CONTRIBUTING.html)**
30+
- **Review the [Contributor's Guide](https://cantera.org/stable/develop/CONTRIBUTING.html).**
3131
Learn about our development workflow, coding standards, and testing practices.
3232

33-
- **Set Up Your Development Environment**
33+
- **Set Up Your Development Environment.**
3434
Follow our [development documentation](https://cantera.org/stable/develop/index.html)
3535
to compile Cantera from source and configure your tools.
3636

37-
- **Reach Out**
37+
- **Reach Out.**
3838
If you're unsure where to start, contact the
3939
[core developers](mailto:developers@cantera.org) to discuss areas where you
4040
can contribute effectively.
@@ -51,3 +51,36 @@ ensure a welcoming environment for everyone.
5151
Your contributions are valuable! If you make significant improvements, feel free to add
5252
your name to the `AUTHORS` file in your pull request. We appreciate and acknowledge the
5353
efforts of all our contributors.
54+
55+
(sec-donations)=
56+
## Donations
57+
58+
Finally, please consider financially supporting Cantera's development! Cantera is a
59+
fiscally sponsored project of NumFOCUS, a 501(c)3 nonprofit dedicated to supporting the
60+
open source scientific computing community. If you have found Cantera to be useful to
61+
your research or company, please consider making a
62+
[donation](https://numfocus.org/donate-to-cantera) to support our efforts. All donations
63+
will be used exclusively to fund the development of Cantera's source code,
64+
documentation, or community.
65+
66+
::::{grid} 1 2 2 2
67+
68+
:::{grid-item}
69+
```{image} _static/img/SponsoredProject.png
70+
:align: center
71+
:alt: Powered by NumFOCUS
72+
:target: https://numfocus.org
73+
:width: 250px
74+
```
75+
:::
76+
77+
:::{grid-item}
78+
```{button-link} https://numfocus.org/donate-to-cantera
79+
:color: primary
80+
:shadow:
81+
:align: center
82+
Donate to Cantera {octicon}`link-external`
83+
```
84+
:::
85+
86+
::::

0 commit comments

Comments
 (0)