Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for 3.0 release #248

Merged
merged 69 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from 67 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
ee9c049
Add 3.0.0b1 API docs
speth Jul 2, 2023
8ae7f27
Update API doc landing page for 3.0
speth Jul 2, 2023
b8f9e96
Remove CTI documentation
speth Jul 2, 2023
292e831
Update scons options for 3.0
speth Jul 2, 2023
44ea7f4
Fix links from dev build docs to dev options list
speth Jul 3, 2023
bb047a3
Update guide to configuration options
speth Jul 3, 2023
1b1688e
Update conda installation instructions
speth Jul 3, 2023
51c4c3f
Conda libcantera-devel is no longer "experimental"
speth Jul 3, 2023
f8daf07
Update Windows instructions
speth Jul 3, 2023
9824c79
Update compilation dependency versions
speth Jul 4, 2023
5f4d703
Document dependency on setuptools, wheel, and pip
speth Jul 5, 2023
f34ad40
Document minimum version of HighFive
speth Jul 5, 2023
255ac61
Update build reqs for conda and Linux distros
speth Jul 6, 2023
1e95f28
Update build reqs for Windows
speth Jul 6, 2023
1ef5ed9
Update build reqs for macOS/Homebrew
speth Jul 6, 2023
9c68ad2
Update git instructions
speth Jul 6, 2023
e2be724
Pull from 3.0 branch of main repo
speth Jul 9, 2023
ac7da0b
Improve formatting of tutorial on C++ headers
speth Jul 11, 2023
b486140
Remove outdated directions for using Cantera.mak
speth Jul 11, 2023
2325645
Update CMakeLists.txt and SConstruct examples
speth Jul 11, 2023
ad437ef
Make page titles less aggressively large
speth Jul 11, 2023
e53dff0
Provide guidance on linking C++ programs to Cantera libraries
speth Jul 11, 2023
ac03143
Provide commands for compiling C++ samples on all OSes
speth Jul 11, 2023
3866c27
Use core.h in C++ sample programs
speth Jul 11, 2023
b46cfe3
Replace use of deprecated Kinetics::reactionString
speth Jul 11, 2023
c6066b6
Update sample output from C++ demos
speth Jul 11, 2023
6c5fd76
Update demo program code to use recommended practices
speth Jul 11, 2023
0c8462f
Minor updates to simple C++ demo
speth Jul 11, 2023
c7fbc88
Revise "factory" C++ demo to describe what it actually does
speth Jul 11, 2023
52e5466
Move aside about Cantera compilation docs off of top-level card
speth Jul 11, 2023
95d334e
Update sample console output in Python tutorial
speth Jul 11, 2023
bf58158
Formatting cleanup of Python tutorial
speth Jul 11, 2023
9d95d89
Update ck2yaml docs
speth Jul 11, 2023
a53dcc8
Update affiliated packages list
speth Jul 11, 2023
a6ecd31
Update recommended citation
speth Jul 11, 2023
2751ca3
Use updated Google Groups link
speth Jul 12, 2023
2c815d3
Migrate conda-build instructions to the conda package repo
speth Jul 12, 2023
a95ff37
Clean up IonFlow links
speth Jul 12, 2023
f690947
Document revised handling of three body reactions
speth Jul 12, 2023
6a85a37
Formatting updates to species thermo page
speth Jul 12, 2023
f5cd80f
line wrap thermodynamics.rst, and fix a couple of typos
speth Jul 12, 2023
1a1d382
line wrap transport.rst
speth Jul 12, 2023
55aaf5f
Minor updates to input files index page
speth Jul 12, 2023
e3b8f03
Update list of phase models
speth Jul 14, 2023
06726e7
Update reactions section of YAML tutorial
speth Jul 14, 2023
d112fa6
Update species thermo types described in YAML tutorial
speth Jul 14, 2023
c48ffbc
Fix a couple of typos
speth Jul 14, 2023
49b11c8
Update pip installation instructions
speth Jul 16, 2023
fa811d6
Note limitations of PyPI packages
speth Jul 16, 2023
26b92d0
Update Ubuntu installation instructions
speth Jul 17, 2023
54177cb
Update macOS Matlab installer instructions
speth Jul 27, 2023
9c9c04b
Minor updates to compilation instructions
speth Jul 28, 2023
a8670ea
Describe new PFR model with surface chemistry
speth Jul 28, 2023
1bf129e
Update SUNDIALS documentation
speth Aug 5, 2023
949b623
Update reactor short descriptions
speth Aug 5, 2023
e33da45
Clean up some links in Reactor documentation
speth Aug 5, 2023
3a548aa
Revise ExtensibleReactor documentation
speth Aug 5, 2023
14d4c1e
Update 3.0.0b1 docs
speth Aug 5, 2023
9c4db8f
Add more links into API docs
speth Aug 5, 2023
99b9bdd
Explain linking to Ubuntu HDF5 packages
speth Aug 8, 2023
dc831ad
Note dependency on sphinx-argparse
speth Aug 13, 2023
d2a766a
Note dependency on PyData Sphinx theme
speth Aug 13, 2023
866e137
Note new doc dependencies on bibtex and perl
speth Aug 17, 2023
dc6078d
Add release notes for Cantera 3.0.0
speth Aug 18, 2023
15aea61
Add contributors to website and jupyter repos
speth Aug 20, 2023
2ba08a3
Update URL for Google Groups links
speth Aug 20, 2023
94e6dbd
Note availability of conda-forge packages for Windows
speth Aug 20, 2023
998170c
Link to Enhancement issues in release notes
speth Aug 21, 2023
c716aa6
Update to reflect final release date and last few PRs for Cantera 3.0.0
speth Aug 22, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
submodules: recursive
repository: Cantera/cantera
path: cantera
ref: 2.6
ref: "3.0"
- uses: actions/checkout@v2
name: Checkout Cantera 'main' repository
with:
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,3 @@ site is built using the [Nikola](https://getnikola.com) static site generator.
* `IC engine example </examples/python/reactors/ic_engine.py.html>`__
* To link to a label in the YAML API docs:
* :ref:`three-body <sec-yaml-three-body>`
* To link to a class defined in `ctml_writer`:
* :cti:class:`falloff_reaction`
2 changes: 1 addition & 1 deletion api-docs
Submodule api-docs updated 3733 files
6 changes: 3 additions & 3 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
BLOG_DESCRIPTION = "This site is for the Cantera software" # (translatable)

# The most recent major release version of Cantera
CANTERA_VERSION = "2.6"
CANTERA_VERSION = "3.0"

# The default context used when looking up :class: or :func: roles
# Options are 'py', 'cti', or 'mat'
Expand Down Expand Up @@ -280,6 +280,7 @@
"api-docs/docs-2.4": "documentation/docs-2.4",
"api-docs/docs-2.5": "documentation/docs-2.5",
"api-docs/docs-2.6": "documentation/docs-2.6",
"api-docs/docs-3.0": "documentation/docs-3.0",
}

FILES_FOLDERS = {"files/survey2013": "survey2013", "files/license": ""}
Expand All @@ -298,8 +299,7 @@
# the site. The format is a dictionary of {source: relative destination}.
# Default is:
EXAMPLES_FOLDERS = {
# "../cantera/samples/python": "examples/python", # starting with Cantera 3.0
"../cantera/interfaces/cython/cantera/examples": "examples/python", # Cantera 2.6
"../cantera/samples/python": "examples/python",
"../cantera-jupyter": "examples/jupyter",
"../cantera/samples/matlab": "examples/matlab",
"../cantera/samples/cxx": "examples/cxx",
Expand Down
10 changes: 5 additions & 5 deletions pages/affiliated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. raw:: html

<h1 class="display-3">Affiliated Packages</h1>
<h1 class="display-4">Affiliated Packages</h1>

.. class:: lead

Expand All @@ -17,7 +17,7 @@ exist that provide more specialized functionality and rely on Cantera. Here we p
non-exhaustive, alphabetical, list of these packages; if you would like us to include your package, please
`submit a pull request <https://github.com/cantera/cantera-website/pulls>`__,
`file an issue <https://github.com/cantera/cantera-website/issues/new>`__, or
post on the `Google Users' Group <https://groups.google.com/forum/#!forum/cantera-users>`__.
post on the `Google Users' Group <https://groups.google.com/g/cantera-users>`__.

------------

Expand All @@ -37,7 +37,7 @@ post on the `Google Users' Group <https://groups.google.com/forum/#!forum/canter

**BIOVIA Materials Studio**: commercial modeling and simulation software for materials science and chemistry.

| `Website <https://www.3dsbiovia.com/products/collaborative-science/biovia-materials-studio/>`__
| `Website <https://www.3ds.com/products-services/biovia/products/molecular-modeling-simulation/biovia-materials-studio/>`__

------------

Expand Down Expand Up @@ -131,5 +131,5 @@ post on the `Google Users' Group <https://groups.google.com/forum/#!forum/canter

**ChemCheck**: A tool to help Cantera users to detect chemical and syntax errors in kinetic models

| `Repository <https://github.com/comocheng/ChemCheck>`__
| Maintainer(s): Chao Xu, Richard West
| `Repository <https://github.com/comocheng/ChemCheck>`__
| Maintainer(s): Chao Xu, Richard West
12 changes: 6 additions & 6 deletions pages/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

.. raw:: html

<h1 class="display-3">The Cantera Community</h1>
<h1 class="display-4">The Cantera Community</h1>

.. class:: lead

Expand Down Expand Up @@ -43,7 +43,7 @@ The Cantera Users' Group
~~~~~~~~~~~~~~~~~~~~~~~~

The `Cantera Users’ Group
<https://groups.google.com/forum/#!forum/cantera-users>`__ on Google Groups is
<https://groups.google.com/g/cantera-users>`__ on Google Groups is
the forum where most Cantera users have their questions asked and answered. If
you need help using Cantera and cannot find an answer in the tutorials or
documentation at Cantera's website, consider joining and asking a question
Expand Down Expand Up @@ -160,7 +160,7 @@ follows:
David G. Goodwin, Harry K. Moffat, Ingmar Schoegl, Raymond L. Speth, and Bryan W.
Weber. *Cantera: An object-oriented software toolkit for chemical kinetics,
thermodynamics, and transport processes*. https://www.cantera.org,
2022. Version 2.6.0. doi:10.5281/zenodo.6387882
2023. Version 3.0.0. doi:10.5281/zenodo.8137090

The following BibTeX entry may also be used:

Expand All @@ -171,10 +171,10 @@ The following BibTeX entry may also be used:
Speth and Bryan W. Weber",
title = "Cantera: An Object-oriented Software Toolkit for Chemical
Kinetics, Thermodynamics, and Transport Processes",
year = 2022,
note = "Version 2.6.0",
year = 2023,
note = "Version 3.0.0",
howpublished = "\url{https://www.cantera.org}",
doi = {10.5281/zenodo.6387882}
doi = {10.5281/zenodo.8137090}
}

If you are using a different version of Cantera, update the ``year``, ``note``
Expand Down
Loading
Loading