Skip to content

Add getting involved page #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions source/affiliated.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ Maintainer(s): Chao Xu, Richard West
:::{grid-item-card} ctwrap
A light-weight Python wrapper facilitating batch simulations.

[Website](https://microcombustion.github.io/ctwrap/)

[Repository](https://github.com/microcombustion/ctwrap)

Maintainer(s): Ingmar Schoegl
Expand All @@ -69,6 +67,14 @@ curvature, and steady 2D flames in a prescribed velocity field.
Maintainer(s): [Ray Speth](https://github.com/speth)
:::

:::{grid-item-card} FPVgen
An automated flamelet progress variable (FPV) table assembly tool.

[Repository](https://github.com/IhmeGroup/FPVgen)

Maintainer(s): Matthew Bonanni
:::

:::{grid-item-card} Frhodo
A GUI-based application for simulating experimental data and optimizing chemical
kinetics mechanisms.
Expand Down
4 changes: 3 additions & 1 deletion source/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ ensuring that the software will remain open source and available for all to use.
In this vein, Cantera software relies exclusively upon the volunteer contributions of
its users. These contributions range from diagnosing and reporting problems/bugs, to
helping others learn to use Cantera, to developing and implementing new software
capabilities.
capabilities. For a brief overview, see our {doc}`getting involved <getting-involved>`
page.

While Cantera provides some standalone models and applications, numerous external
packages exist that provide more specialized functionality and rely on Cantera. We
Expand Down Expand Up @@ -188,6 +189,7 @@ Donate to Cantera {octicon}`link-external`
:hidden:

News <news-index>
Getting Involved <getting-involved>
Affiliated Packages <affiliated>
Governance <governance>
Dave Goodwin <dave-goodwin>
Expand Down
53 changes: 53 additions & 0 deletions source/getting-involved.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Getting Involved

Cantera is an open-source suite for chemical kinetics, thermodynamics, and transport
modeling, widely used in fields like combustion, electrochemistry, and materials
science. As a community-driven project, we depend on contributions from users and
developers who are interested in writing code, improving documentation, or assisting
fellow users.

## Ways to Contribute

- **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**
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**
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.

## Getting Started

- **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**
Follow our [development documentation](https://cantera.org/stable/develop/index.html)
to compile Cantera from source and configure your tools.

- **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.

## Community and Support

Cantera is governed by a {doc}`Steering Committee <governance>` dedicated to
maintaining a respectful and inclusive community. All interactions are guided by our
[Code of Conduct](https://github.com/Cantera/cantera/blob/main/CODE_OF_CONDUCT.md) to
ensure a welcoming environment for everyone.

## Recognition

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.