diff --git a/doc/sphinx/_static/images/SponsoredProject.png b/doc/sphinx/_static/images/SponsoredProject.png new file mode 100644 index 000000000..a02421031 Binary files /dev/null and b/doc/sphinx/_static/images/SponsoredProject.png differ diff --git a/doc/sphinx/about.rst b/doc/sphinx/about.rst new file mode 100644 index 000000000..a8ef9dd87 --- /dev/null +++ b/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 +`_ for +assistance in getting started. + +All online and in-person interactions and communications related to Cantera are +governed by the `Cantera Code of Conduct +`_. 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 +`_ 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 `_ +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 + +
+ Donate to Cantera +
diff --git a/doc/sphinx/cttheme/static/cantera.css b/doc/sphinx/cttheme/static/cantera.css index 7e00d7c01..666d06bc2 100644 --- a/doc/sphinx/cttheme/static/cantera.css +++ b/doc/sphinx/cttheme/static/cantera.css @@ -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; +} diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 72939f400..8a0dc5f17 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -27,6 +27,7 @@ Documentation .. toctree:: :maxdepth: 2 + about faq Installation Instructions Compiliation Instructions