Skip to content

Commit

Permalink
[Doc] Add 'about' page to docs
Browse files Browse the repository at this point in the history
Includes info about NumFOCUS sponsorship and donation link, as well as
the steering committee
  • Loading branch information
bryanwweber committed Feb 10, 2018
1 parent c78a11b commit 2abc57e
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 0 deletions.
Binary file added doc/sphinx/_static/images/SponsoredProject.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions doc/sphinx/about.rst
@@ -0,0 +1,67 @@
.. _sec-about:

*************
About Cantera
*************

Cantera is an open source scientific computing project, that allows users to
quickly and efficiently incorporate and execute fundamental thermodynamic,
chemical kinetic, and species transport calculations in their work. This can be
achieved by standalone command-line calls to core Cantera functions,
incorporating these calls into bespoke code or software, or by using any of the
solvers or examples distributed with the Cantera software package.

Cantera was originally started by Prof. David G. Goodwin at the California
Institute of Technology. Building on Prof. Goodwin's legacy, Cantera is licensed
under a permissive 3-Clause BSD license, ensuring that the software will remain
available for all to use.

Cantera is developed openly on GitHub. Contributions are welcomed from anyone in
the community; please see the `Contributors guide
<https://github.com/Cantera/cantera/blob/master/CONTRIBUTING.md>`_ for
assistance in getting started.

All online and in-person interactions and communications related to Cantera are
governed by the `Cantera Code of Conduct
<https://github.com/Cantera/cantera/blob/master/CODE_OF_CONDUCT.md>`_. This code
of conduct sets expectations for the community to ensure that users and
contributors are able to participate in a respectful and welcoming environment.

Steering Committee
==================

The role of the steering committee is to ensure the long-term health of the
Cantera project. This includes overseeing the development of the Cantera code
and community in a way that most benefits the entire community of users and
contributors. The steering committee can be contacted at `steering@cantera.org
<mailto:steering@cantera.org>`_ The current steering committee (in alphabetical
order) is:

* Steven Decaluwe, Colorado School of Mines
* \C. Franklin Goldsmith, Brown University
* Kyle Niemeyer, Oregon State University
* Raymond Speth, Massachusetts Institute of Technology
* Bryan Weber, University of Connecticut
* Richard West, Northeastern University

Donations
=========

Cantera is a fiscally sponsored project of NumFOCUS, a 501(c)3 nonprofit
dedicated to supporting the open source scientific computing community. If you
have found Cantera to be useful to your research or company, please consider
making a `donation <https://www.flipcause.com/secure/cause_pdetails/Mjk3MjU=>`_
to support our efforts. All donations will be used exclusively to fund the
development of Cantera's source code, documentation, or community.

.. image:: /_static/images/SponsoredProject.png
:alt: Powered by NumFOCUS
:target: https://numfocus.org
:align: center
:scale: 50%

.. raw:: html

<div style="text-align:center">
<a href="https://www.flipcause.com/secure/cause_pdetails/Mjk3MjU=" class="button">Donate to Cantera</a>
</div>
21 changes: 21 additions & 0 deletions doc/sphinx/cttheme/static/cantera.css
Expand Up @@ -9,3 +9,24 @@ dl.class, dl.function {
border-top: 2px solid #888;
padding-top: 4px;
}

a.button {
margin-top: 16px;
background-color: #BFD1D4;

text-decoration: none !important;
text-align: center;
display: inline-block;

color: white;
font-size: 24px;
padding: 12px 28px;

-webkit-transition-duration: 0.4s; /* Safari */
transition-duration: 0.4s;
}

a.button:hover {
background-color: #4CAF50; /* Green */
color: white;
}
1 change: 1 addition & 0 deletions doc/sphinx/index.rst
Expand Up @@ -27,6 +27,7 @@ Documentation
.. toctree::
:maxdepth: 2

about
faq
Installation Instructions <install>
Compiliation Instructions <compiling/index>
Expand Down

0 comments on commit 2abc57e

Please sign in to comment.