Skip to content

Latest commit

 

History

History
174 lines (129 loc) · 6.62 KB

README.rst

File metadata and controls

174 lines (129 loc) · 6.62 KB

cantera logo

doi codecov travisci appveyor GitHub release

What is Cantera?

Cantera is an open-source collection of object-oriented software tools for problems involving chemical kinetics, thermodynamics, and transport processes. Among other things, it can be used to:

  • Evaluate thermodynamic and transport properties of mixtures
  • Compute chemical equilibrium
  • Evaluate species chemical production rates
  • Conduct kinetics simulations with large reaction mechanisms
  • Simulate one-dimensional flames
  • Conduct reaction path analysis
  • Create process simulations using networks of stirred reactors
  • Model non-ideal fluids

Cantera can be used from Python and Matlab, or in applications written in C++ and Fortran 90. A number of examples of Cantera's capabilities are available in the form of Jupyter notebooks. These examples can be tried interactively, in the cloud by using the following MyBinder link:

Installation

Installation instructions for the current release of Cantera are available from the main Cantera documentation site. Installers are provided for Windows (MSI packages), macOS (through Homebrew), and Ubuntu. Anaconda packages containing the Cantera Python module are also available for Windows, macOS, and Linux.

For other platforms, or for users wishing to install a development version of Cantera, compilation instructions are also available.

Documentation

The documentation offers a number of starting points:

Documentation for the development version of Cantera is also available.

Code of Conduct

conduct

In order to have a more open and welcoming community, Cantera adheres to a code of conduct adapted from the Contributor Covenant code of conduct.

Please adhere to this code of conduct in any interactions you have in the Cantera community. It is strictly enforced on all official Cantera repositories, websites, users' group, and other resources. If you encounter someone violating these terms, please contact the code of conduct team (@speth, @bryanwweber, and @kyleniemeyer) and we will address it as soon as possible.

Development Site

The current development version is 2.5.0a4. The current stable version is 2.4.0. The latest Cantera source code, the issue tracker for bugs and enhancement requests, downloads of Cantera releases and binary installers , and the Cantera wiki can all be found on Github.

Users' Group

The Cantera Users' Group is a message board / mailing list for discussions amongst Cantera users.

Cantera Gitter Chat

https://badges.gitter.im/org.png

The Cantera Gitter Chat is a public chat client that is linked to users' Github account. The developers do not closely monitor the discussion, so any discussion at all of Cantera functionality such as how to use certain function calls, syntax problems, input files, etc. should be directed the User's Group. All conversations in the Gitter room will be covered under the Cantera Code of Conduct, so please be nice.

The chat room is a place to strengthen and develop the Cantera community, discuss tangentially-related topics such as how to model the underlying physics of a problem , share cool applications you’ve developed, etc.

Summary:

“How do I perform this Cantera function call?” --> User's Group

"What do I do with the variables that a Cantera function call returns?” --> Chat

Continuous Integration Status

Platform Site Status
Linux & OS X Travis CI travisci
Windows x64 Appveyor appveyor

NumFOCUS

Cantera is a fiscally-sponsored project of NumFOCUS, a non-profit dedicated to supporting the open source scientific computing community. Please consider making a donation to support the development of Cantera through NumFOCUS.

Powered by NumFOCUS