Catera with additional transport models
Find a file
Ray Speth f17750e483 Make species names case-preserving instead of case-sensitive
This improves interoperability when working with mechanisms which use differing
conventions for naming species using uppercase or lowercase.
2016-10-13 18:40:03 -04:00
data Remove dummy element from elements.xml 2016-08-30 20:31:31 -04:00
doc [Doc] Fix typo in custom element declaration 2016-08-30 14:46:37 -04:00
ext [SCons] Fix license file generation when using system version of fmt 2016-07-05 15:11:33 -04:00
include/cantera [clib] Make clib headers public 2016-10-13 18:40:03 -04:00
interfaces Make species names case-preserving instead of case-sensitive 2016-10-13 18:40:03 -04:00
platform/posix [SCons] Install to lib64 directory on operating systems that use this 2016-07-25 14:42:46 -04:00
samples Replace existing copyright notices with uniform copyright/license info 2016-10-10 22:19:01 -04:00
site_scons [SCons] Install license file with licenses for 3rd-party code 2016-06-24 15:27:20 -04:00
src Make species names case-preserving instead of case-sensitive 2016-10-13 18:40:03 -04:00
test Make species names case-preserving instead of case-sensitive 2016-10-13 18:40:03 -04:00
test_problems Replace existing copyright notices with uniform copyright/license info 2016-10-10 22:19:01 -04:00
.gitignore Compile cppformat and include it in the Cantera library 2015-10-14 18:45:22 -04:00
.gitmodules Add Eigen submodule (mirrored on Github at Cantera/eigen-mirror) 2016-05-14 21:56:17 -04:00
.travis.yml Fix Travis build on OS X 2016-10-10 00:32:48 -04:00
appveyor.yml Add Appvyeor config file 2016-09-06 20:34:24 -04:00
AUTHORS Add institutional affiliations to AUTHORS 2016-10-10 21:18:54 -04:00
INSTALL Added INSTALL with basic instructions for building with SCons 2012-07-03 17:49:59 +00:00
License.txt Update copyright statement in License.txt 2016-10-10 21:20:53 -04:00
README.rst Rewrite README.rst 2016-09-11 00:08:05 -04:00
SConstruct Fix configuration Fortran environment 2016-08-15 21:40:24 -04:00

*******
Cantera
*******

Version 2.3.0a3 (development)

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
<https://github.com/Cantera/cantera-jupyter>`_ are available in the form of
Jupyter notebooks. These examples can be tried interactively, in the cloud by
using the following Binder link:

.. image:: http://mybinder.org/badge.svg
    :target: http://mybinder.org:/repo/cantera/cantera-jupyter

Installation
============

`Installation instructions for the current release of Cantera
<http://cantera.github.io/docs/sphinx/html/install.html>`_ are available from
the main `Cantera documentation site
<http://cantera.github.io/docs/sphinx/html/index.html>`_. Installers are
provided for Windows (MSI packages), Mac OS X (through Homebrew), and
Ubuntu. Anaconda packages containing the Cantera Python module are also
available for Windows, OS X, and Linux.

.. image:: https://anaconda.org/cantera/cantera/badges/installer/conda.svg
    :target: https://conda.anaconda.org/cantera

For other platforms, or for users wishing to install a development version of
Cantera, `compilation instructions
<http://cantera.github.io/docs/sphinx/html/compiling.html>`_ are also available.

Documentation
=============

The `documentation <http://cantera.github.io/docs/sphinx/html/index.html>`_
offers a number of starting points:

- `Python tutorial
  <http://cantera.github.io/docs/sphinx/html/cython/tutorial.html>`_
- `A guide to Cantera's input file format
  <http://cantera.github.io/docs/sphinx/html/cti/index.html>`_
- `A list of frequently asked questions
  <http://cantera.github.io/docs/sphinx/html/faq.html>`_

`Documentation for the development version of Cantera
<http://cantera.github.com/dev-docs/sphinx/html/index.html>`_ is also available.

Development Site
================

The `latest Cantera source code <https://github.com/Cantera/cantera>`_, the
`issue tracker <https://github.com/Cantera/cantera/issues>`_ for bugs and
enhancement requests, `downloads of Cantera releases and binary installers
<https://github.com/Cantera/cantera/releases>`_ , and the `Cantera wiki
<https://github.com/Cantera/cantera/wiki>`_ can all be found on Github.

Users' Group
============

The `Cantera Users' Group <http://groups.google.com/group/cantera-users>`_ is a
message board / mailing list for discussions amongst Cantera users.

Continuous Integration Status
=============================

Travis builds (Linux & OS X):

.. image:: https://travis-ci.org/speth/cantera.svg?branch=master
    :target: https://travis-ci.org/speth/cantera

Appveyor builds (Windows):

.. image:: https://ci.appveyor.com/api/projects/status/auhd35qn9cdmkpoj?svg=true
    :target: https://ci.appveyor.com/project/Cantera/cantera