Skip to content

Commit

Permalink
[Doc] URL updates for new website organization
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Nov 7, 2024
1 parent e36c9b9 commit b08713c
Show file tree
Hide file tree
Showing 11 changed files with 59 additions and 62 deletions.
12 changes: 5 additions & 7 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,14 @@ be able to help you out.

## Documentation

The [documentation](https://cantera.org/documentation)
The [Cantera Website](https://cantera.org)
offers a number of starting points:

- [Python tutorial](https://cantera.org/tutorials/python-tutorial.html)
- [Application Examples in Python (Jupyter)](https://github.com/Cantera/cantera-jupyter#cantera-jupyter)
- [A guide to Cantera's input file format](https://cantera.org/tutorials/input-files.html)
- [Python tutorial](https://cantera.org/stable/userguide/python-tutorial.html)
- [Gallery of Python Examples](https://cantera.org/stable/examples/python/index.html)
- [A guide to Cantera's input file format](https://cantera.org/stable/userguide/input-tutorial.html)
- [Information about the Cantera community](https://cantera.org/community.html)

Documentation for the [development version of
Cantera](https://cantera.org/documentation/dev-docs.html) is also available.
- [Developers: Compile and Modify Cantera](https://cantera.org/stable/develop/index.html)

## Contributions

Expand Down
5 changes: 4 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,7 @@ shown by running `scons help`.

## Detailed Instructions

See the instructions available [online](https://cantera.org/install/compiling-install.html).
See the instructions available for installing packages providing the
[current stable version](https://cantera.org/stable/install/index.html) or compilation
instructions for building the
[latest development version](https://cantera.org/dev/develop/index.html).
27 changes: 11 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ using the following MyBinder link:
Installation
============

|pip| |anaconda| |conda-forge|
|pip| |conda-forge|

`Installation instructions for the current release of Cantera
<https://cantera.org/install/index.html>`_ are available from the main `Cantera
<https://cantera.org/stable/install/index.html>`_ are available from the main `Cantera
documentation site <https://cantera.org>`_.

- The Python module can also be installed using pip on Windows, macOS, and Linux.
Expand All @@ -48,28 +48,26 @@ documentation site <https://cantera.org>`_.
RHEL, Gentoo, and FreeBSD.

- For other platforms, or for users wishing to install a development version of
Cantera, `compilation instructions <https://cantera.org/install/compiling-install.html#sec-compiling>`_
Cantera, `compilation instructions <https://cantera.org/stable/develop/index.html>`_
are also available.

Documentation
=============

The `documentation <https://cantera.org/documentation>`_
offers a number of starting points:
The `documentation <https://cantera.org>`_ offers a number of starting points:

- `Python tutorial
<https://cantera.org/tutorials/python-tutorial.html>`_
<https://cantera.org/stable/userguide/python-tutorial.html>`_
- `Application Examples in Python
<https://cantera.org/examples/jupyter/index.html>`_
<https://cantera.org/stable/examples/python/index.html>`_
- `A guide to Cantera's input file format
<https://cantera.org/tutorials/input-files.html>`_
<https://cantera.org/stable/userguide/input-tutorial.html>`_
- `User Guide: Tutorials, FAQ, and Task Guides
<https://cantera.org/stable/userguide/index.html>`
- `Information about the Cantera community
<https://cantera.org/community.html>`_
- `Affiliated packages
<https://cantera.org/affiliated-packages.html>`_

`Documentation for the development version of Cantera
<https://cantera.org/documentation/dev-docs.html>`_ is also available.
<https://cantera.org/affiliated.html>`_

Code of Conduct
===============
Expand Down Expand Up @@ -125,7 +123,7 @@ development of Cantera through NumFOCUS.
:target: https://numfocus.org/donate-to-cantera
:alt: Powered by NumFOCUS

.. |cantera| image:: https://cantera.org/assets/img/cantera-logo.png
.. |cantera| image:: https://cantera.org/_static/cantera-logo.png
:target: https://cantera.org
:alt: cantera logo
:width: 675px
Expand All @@ -147,8 +145,5 @@ development of Cantera through NumFOCUS.
.. |pip| image:: https://img.shields.io/pypi/v/cantera
:target: https://pypi.org/project/Cantera/

.. |anaconda| image:: https://img.shields.io/conda/v/cantera/cantera
:target: https://anaconda.org/Cantera/cantera

.. |conda-forge| image:: https://img.shields.io/conda/v/conda-forge/cantera
:target: https://anaconda.org/conda-forge/cantera
22 changes: 11 additions & 11 deletions doc/doxygen/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

> **Note:** For release notes and previous versions of the Python/MATLAB
> interface documentation, refer to
> [cantera.org](https://cantera.org/documentation/index.html#need-something-else).
> [cantera.org](https://cantera.org/stable/reference/index.html).
**%Cantera Developer API** versions:
**%Cantera C++ API** versions:

* [dev/latest](https://cantera.org/documentation/dev/doxygen/html/index.html) (unstable)
* [v3.0.0](https://cantera.org/documentation/docs-3.0/doxygen/html/index.html)
* [v2.6.0](https://cantera.org/documentation/docs-2.6/doxygen/html/modules.html)
* [v2.5.1](https://cantera.org/documentation/docs-2.5/doxygen/html/modules.html)
* [v2.4.0](https://cantera.org/documentation/docs-2.4/doxygen/html/modules.html)
* [v2.3.0](https://cantera.org/documentation/docs-2.3/doxygen/html/modules.html)
* [v2.2.1](https://cantera.org/documentation/docs-2.2/doxygen/html/modules.html)
* [v2.1.2](https://cantera.org/documentation/docs-2.1/doxygen/html/modules.html)
* [v2.0.2](https://cantera.org/documentation/docs-2.0/doxygen/html/modules.html)
* [dev/latest](https://cantera.org/dev/cxx/index.html) (unstable)
* [v3.0.0](https://cantera.org/3.0/doxygen/html/index.html)
* [v2.6.0](https://cantera.org/2.6/doxygen/html/modules.html)
* [v2.5.1](https://cantera.org/2.5/doxygen/html/modules.html)
* [v2.4.0](https://cantera.org/2.4/doxygen/html/modules.html)
* [v2.3.0](https://cantera.org/2.3/doxygen/html/modules.html)
* [v2.2.1](https://cantera.org/2.2/doxygen/html/modules.html)
* [v2.1.2](https://cantera.org/2.1/doxygen/html/modules.html)
* [v2.0.2](https://cantera.org/2.0/doxygen/html/modules.html)
22 changes: 11 additions & 11 deletions doc/sphinx/reference/releasenotes/v2.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ Published on June 5, 2015 | [Full release on GitHub](https://github.com/Cantera/
New major version. Highlights include:

- Reformulated multicomponent diffusion calculation to improve 1D solver convergence.
- Introduction of `Species` and `Reaction` classes which can be used to construct and modify `ThermoPhase` / `Kinetics` objects on-the-fly, without necessarily using CTI/XML input files. See the new examples [`extract_submechanism.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/kinetics_extract_submechanism.html) and [`mechanism_reduction.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/kinetics_mechanism_reduction.html).
- Introduction of `Species` and `Reaction` classes which can be used to construct and modify `ThermoPhase` / `Kinetics` objects on-the-fly, without necessarily using CTI/XML input files. See the new examples [`extract_submechanism.py`](https://cantera.org/2.2/sphinx/html/cython/examples/kinetics_extract_submechanism.html) and [`mechanism_reduction.py`](https://cantera.org/2.2/sphinx/html/cython/examples/kinetics_mechanism_reduction.html).
- Better handling of CTI and XML files: Parsed CTI and XML files are cached based on modification time and file content, and implicit conversions are done without generating `.xml` files. Phases can be imported directly from XML or CTI strings. Both CTI and XML files can import species and reactions from other CTI or XML files.
- Enable re-initialization of reactor networks, which improves efficiency for integration with CFD-like codes - see the example [`surf_pfr.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/reactors_surf_pfr.html).
- Introduction of a simple radiation model for flames (optically thin, gray gas for CO2 and H2O) - see the example [`diffusion_flame.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/onedim_diffusion_flame.html).
- Efficient sensitivity analysis of 1D flame solutions (see [`flamespeed_sensitivity.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/onedim_flamespeed_sensitivity.html)).
- Added strain rate calculations for diffusion flames (see [`diffusion_flame_extinction.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/onedim_diffusion_flame_extinction.html) and [`diffusion_flame_batch.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/onedim_diffusion_flame_batch.html)).
- Added premixed counterflow flame configuration to Python module (see [`premixed_counterflow_flame.py`](https://cantera.org/documentation/docs-2.2/sphinx/html/cython/examples/onedim_premixed_counterflow_flame.html)).
- Enable re-initialization of reactor networks, which improves efficiency for integration with CFD-like codes - see the example [`surf_pfr.py`](https://cantera.org/2.2/sphinx/html/cython/examples/reactors_surf_pfr.html).
- Introduction of a simple radiation model for flames (optically thin, gray gas for CO2 and H2O) - see the example [`diffusion_flame.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_diffusion_flame.html).
- Efficient sensitivity analysis of 1D flame solutions (see [`flamespeed_sensitivity.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_flamespeed_sensitivity.html)).
- Added strain rate calculations for diffusion flames (see [`diffusion_flame_extinction.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_diffusion_flame_extinction.html) and [`diffusion_flame_batch.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_diffusion_flame_batch.html)).
- Added premixed counterflow flame configuration to Python module (see [`premixed_counterflow_flame.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_premixed_counterflow_flame.html)).
- Allow Sundials to link to external (optimized) BLAS/LAPACK libraries.
- Support for Sundials 2.6.
- Updated Matlab toolbox documentation, which is included in the [online HTML documentation](https://cantera.org/documentation/docs-2.2/sphinx/html/matlab/index.html).
- Updated Matlab toolbox documentation, which is included in the [online HTML documentation](https://cantera.org/2.2/sphinx/html/matlab/index.html).

## Downloads available

- Source code (all platforms) - Download `cantera-2.2.0.tar.gz` from GitHub, and see the [compilation guide](https://cantera.org/documentation/docs-2.2/sphinx/html/compiling.html).
- Windows MSI installers for x86 and x64 systems, including Python modules for Python 2.7, 3.3, and 3.4. See [installation instructions](https://cantera.org/documentation/docs-2.2/sphinx/html/install.html#windows) for details.
- Ubuntu packages for Trusty (14.04 LTS), Utopic, and Vivid via a Launchpad PPA; see [installation instructions](https://cantera.org/documentation/docs-2.2/sphinx/html/install.html#ubuntu)
- OS X Homebrew formula; see [installation instructions](https://cantera.org/documentation/docs-2.2/sphinx/html/install.html#mac-os-x)
- Source code (all platforms) - Download `cantera-2.2.0.tar.gz` from GitHub, and see the [compilation guide](https://cantera.org/2.2/sphinx/html/compiling.html).
- Windows MSI installers for x86 and x64 systems, including Python modules for Python 2.7, 3.3, and 3.4. See [installation instructions](https://cantera.org/2.2/sphinx/html/install.html#windows) for details.
- Ubuntu packages for Trusty (14.04 LTS), Utopic, and Vivid via a Launchpad PPA; see [installation instructions](https://cantera.org/2.2/sphinx/html/install.html#ubuntu)
- OS X Homebrew formula; see [installation instructions](https://cantera.org/2.2/sphinx/html/install.html#mac-os-x)
14 changes: 7 additions & 7 deletions doc/sphinx/reference/releasenotes/v2.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Published on January 19, 2017 | [Full release on GitHub](https://github.com/Cant

## Installation Options

- Conda / anaconda packages for Windows, Linux, and macOS via the `cantera` channel. See [installation instructions](https://cantera.org/documentation/docs-2.3/sphinx/html/install.html) for more details.
- Windows binary installers (downloads below; To use the Matlab toolbox on Windows, install both `Cantera-2.3.0-x64.msi` and one of the Python modules. The Python installers are standalone and do not require the base Cantera package. Installers are available Python 2.7, Python 3.4, Python 3.5, and Python 3.6. See [detailed instructions](https://cantera.org/documentation/docs-2.3/sphinx/html/install.html#windows) for more.
- Ubuntu packages for 16.04 (Xenial Xerus) and 16.10 (Yakkety Yak) are available via the PPA at https://launchpad.net/~speth/+archive/ubuntu/cantera. Additional details available [here](https://cantera.org/documentation/docs-2.3/sphinx/html/install.html#ubuntu).
- Homebrew formula for macOS. See [additonal instructions](https://cantera.org/documentation/docs-2.3/sphinx/html/install.html#homebrew).
- Download and compile the source code. Full instructions [here](https://cantera.org/documentation/docs-2.3/sphinx/html/compiling/index.html).
- Conda / anaconda packages for Windows, Linux, and macOS via the `cantera` channel. See [installation instructions](https://cantera.org/2.3/sphinx/html/install.html) for more details.
- Windows binary installers (downloads below; To use the Matlab toolbox on Windows, install both `Cantera-2.3.0-x64.msi` and one of the Python modules. The Python installers are standalone and do not require the base Cantera package. Installers are available Python 2.7, Python 3.4, Python 3.5, and Python 3.6. See [detailed instructions](https://cantera.org/2.3/sphinx/html/install.html#windows) for more.
- Ubuntu packages for 16.04 (Xenial Xerus) and 16.10 (Yakkety Yak) are available via the PPA at https://launchpad.net/~speth/+archive/ubuntu/cantera. Additional details available [here](https://cantera.org/2.3/sphinx/html/install.html#ubuntu).
- Homebrew formula for macOS. See [additonal instructions](https://cantera.org/2.3/sphinx/html/install.html#homebrew).
- Download and compile the source code. Full instructions [here](https://cantera.org/2.3/sphinx/html/compiling/index.html).

## Documentation

Documentation for Cantera 2.3.0 can be found at <https://cantera.org/documentation/docs-2.3/sphinx/html/index.html>.
Documentation for Cantera 2.3.0 can be found at <https://cantera.org/2.3/sphinx/html/index.html>.

## Changes in Cantera 2.3.0

Expand All @@ -39,6 +39,6 @@ Highlights are listed here. See the [full changelog](https://github.com/Cantera/
- Use Sundials and Eigen to eliminate the need for bundled LAPACK
- Added Conda build recipe and made binaries available through anaconda.org
- Add support for Sundials 2.7
- Deprecate unused classes, functions, arguments, and constants (see <https://cantera.org/documentation/docs-2.3/doxygen/html/deprecated.html> for details)
- Deprecate unused classes, functions, arguments, and constants (see <https://cantera.org/2.3/doxygen/html/deprecated.html> for details)
- Add notices to documentation for classes with no tests or examples (see https://github.com/Cantera/cantera/issues/267)
- Make clib usable as a pure C (not C++) interface and add tests
Loading

0 comments on commit b08713c

Please sign in to comment.