mirror of
https://github.com/Cantera/cantera.git
synced 2025-02-25 18:55:29 -06:00
94 lines
3.3 KiB
ReStructuredText
94 lines
3.3 KiB
ReStructuredText
|
|
*******
|
|
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/Cantera/cantera.svg?branch=master
|
|
:target: https://travis-ci.org/Cantera/cantera
|
|
|
|
Appveyor builds (Windows):
|
|
|
|
.. image:: https://ci.appveyor.com/api/projects/status/auhd35qn9cdmkpoj?svg=true
|
|
:target: https://ci.appveyor.com/project/Cantera/cantera
|