research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add NumFOCUS donation link to README

Browse source 
Also update some URLs to HTTPS
This commit is contained in:
Bryan W. Weber 2019-03-20 09:28:59 -04:00
parent d25637d0ea
commit 654e582bc0
No known key found for this signature in database
GPG key ID: 3A93E209C87E1FE7
1 changed files with 41 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
README.rst
View file

@ -9,8 +9,8 @@ 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:
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
@ -25,28 +25,27 @@ 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:
using the following MyBinder link:
.. image:: http://mybinder.org/badge.svg
:target: http://mybinder.org:/repo/cantera/cantera-jupyter
.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/repo/cantera/cantera-jupyter
Installation
============
`Installation instructions for the current release of Cantera
<https://cantera.org/install/index.html>`_ are available from
the main `Cantera documentation site
<https://cantera.org>`_. 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.
<https://cantera.org/install/index.html>`_ are available from the main `Cantera
documentation site <https://cantera.org>`_. 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.
.. image:: https://anaconda.org/cantera/cantera/badges/installer/conda.svg
:target: https://anaconda.org/Cantera/cantera
For other platforms, or for users wishing to install a development version of
Cantera, `compilation instructions
<https://cantera.org/install/index.html>`_ are also available.
Cantera, `compilation instructions <https://cantera.org/install/index.html>`_
are also available.
Documentation
=============
@ -71,7 +70,7 @@ Code of Conduct
.. image:: https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square
:alt: conduct
:target: http://contributor-covenant.org/version/1/4/
:target: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
In order to have a more open and welcoming community, Cantera adheres to a
`code of conduct <CODE_OF_CONDUCT.md>`_ adapted from the `Contributor Covenent
@ -79,20 +78,19 @@ code of conduct <https://contributor-covenant.org/>`_.
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 <mailto:conduct@cantera.org>`_
(`@speth <https://github.com/speth>`_,
`@bryanwweber <https://github.com/bryanwweber>`_, and
`@kyleniemeyer <https://github.com/kyleniemeyer>`_)
and we will address it as soon as possible.
repositories, websites, users' group, and other resources. If you encounter
someone violating these terms, please `contact the code of conduct team
<mailto:conduct@cantera.org>`_ (`@speth <https://github.com/speth>`_,
`@bryanwweber <https://github.com/bryanwweber>`_, and `@kyleniemeyer
<https://github.com/kyleniemeyer>`_) and we will address it as soon as
possible.
Development Site
================
The current development version is 2.5.0a2. The current stable version is 2.4.0.
The `latest Cantera source code <https://github.com/Cantera/cantera>`_, the
`issue tracker <https://github.com/Cantera/cantera/issues>`_ for bugs and
The current development version is 2.5.0a2. The current stable version is
2.4.0. 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.
@ -100,25 +98,33 @@ enhancement requests, `downloads of Cantera releases and binary installers
Users' Group
============
The `Cantera Users' Group <http://groups.google.com/group/cantera-users>`_ is a
The `Cantera Users' Group <https://groups.google.com/group/cantera-users>`_ is a
message board / mailing list for discussions amongst Cantera users.
Cantera Gitter Chat
============
===================
.. image:: https://badges.gitter.im/org.png
:target: https://gitter.im/Cantera/Lobby
The `Cantera Gitter Chat <https://gitter.im/Cantera/Lobby>`_ 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 `Cantera Gitter Chat <https://gitter.im/Cantera/Lobby>`_ 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.
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
"What do I do with the variables that a Cantera function call returns?” -->
Chat
Continuous Integration Status
@ -135,19 +141,16 @@ 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.
Cantera is a fiscally-sponsored project of `NumFOCUS <https://numfocus.org>`__,
a non-profit dedicated to supporting the open source scientific computing
community. Please consider `making a donation
<https://numfocus.salsalabs.org/donate-to-cantera/index.html>`__ to support the
development of Cantera through NumFOCUS.
.. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:target: https://numfocus.org
:target: https://numfocus.salsalabs.org/donate-to-cantera/index.html
:alt: Powered by NumFOCUS
.. |cantera| image:: https://cantera.org/assets/img/cantera-logo.png
:target: https://cantera.org
:alt: cantera logo