Skip to content

Commit b08713c

Browse files
committed
[Doc] URL updates for new website organization
1 parent e36c9b9 commit b08713c

File tree

11 files changed

+59
-62
lines changed

11 files changed

+59
-62
lines changed

.github/SUPPORT.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,14 @@ be able to help you out.
2222

2323
## Documentation
2424

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

28-
- [Python tutorial](https://cantera.org/tutorials/python-tutorial.html)
29-
- [Application Examples in Python (Jupyter)](https://github.com/Cantera/cantera-jupyter#cantera-jupyter)
30-
- [A guide to Cantera's input file format](https://cantera.org/tutorials/input-files.html)
28+
- [Python tutorial](https://cantera.org/stable/userguide/python-tutorial.html)
29+
- [Gallery of Python Examples](https://cantera.org/stable/examples/python/index.html)
30+
- [A guide to Cantera's input file format](https://cantera.org/stable/userguide/input-tutorial.html)
3131
- [Information about the Cantera community](https://cantera.org/community.html)
32-
33-
Documentation for the [development version of
34-
Cantera](https://cantera.org/documentation/dev-docs.html) is also available.
32+
- [Developers: Compile and Modify Cantera](https://cantera.org/stable/develop/index.html)
3533

3634
## Contributions
3735

INSTALL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,7 @@ shown by running `scons help`.
1515

1616
## Detailed Instructions
1717

18-
See the instructions available [online](https://cantera.org/install/compiling-install.html).
18+
See the instructions available for installing packages providing the
19+
[current stable version](https://cantera.org/stable/install/index.html) or compilation
20+
instructions for building the
21+
[latest development version](https://cantera.org/dev/develop/index.html).

README.rst

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ using the following MyBinder link:
3333
Installation
3434
============
3535

36-
|pip| |anaconda| |conda-forge|
36+
|pip| |conda-forge|
3737

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

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

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

5454
Documentation
5555
=============
5656

57-
The `documentation <https://cantera.org/documentation>`_
58-
offers a number of starting points:
57+
The `documentation <https://cantera.org>`_ offers a number of starting points:
5958

6059
- `Python tutorial
61-
<https://cantera.org/tutorials/python-tutorial.html>`_
60+
<https://cantera.org/stable/userguide/python-tutorial.html>`_
6261
- `Application Examples in Python
63-
<https://cantera.org/examples/jupyter/index.html>`_
62+
<https://cantera.org/stable/examples/python/index.html>`_
6463
- `A guide to Cantera's input file format
65-
<https://cantera.org/tutorials/input-files.html>`_
64+
<https://cantera.org/stable/userguide/input-tutorial.html>`_
65+
- `User Guide: Tutorials, FAQ, and Task Guides
66+
<https://cantera.org/stable/userguide/index.html>`
6667
- `Information about the Cantera community
6768
<https://cantera.org/community.html>`_
6869
- `Affiliated packages
69-
<https://cantera.org/affiliated-packages.html>`_
70-
71-
`Documentation for the development version of Cantera
72-
<https://cantera.org/documentation/dev-docs.html>`_ is also available.
70+
<https://cantera.org/affiliated.html>`_
7371

7472
Code of Conduct
7573
===============
@@ -125,7 +123,7 @@ development of Cantera through NumFOCUS.
125123
:target: https://numfocus.org/donate-to-cantera
126124
:alt: Powered by NumFOCUS
127125

128-
.. |cantera| image:: https://cantera.org/assets/img/cantera-logo.png
126+
.. |cantera| image:: https://cantera.org/_static/cantera-logo.png
129127
:target: https://cantera.org
130128
:alt: cantera logo
131129
:width: 675px
@@ -147,8 +145,5 @@ development of Cantera through NumFOCUS.
147145
.. |pip| image:: https://img.shields.io/pypi/v/cantera
148146
:target: https://pypi.org/project/Cantera/
149147

150-
.. |anaconda| image:: https://img.shields.io/conda/v/cantera/cantera
151-
:target: https://anaconda.org/Cantera/cantera
152-
153148
.. |conda-forge| image:: https://img.shields.io/conda/v/conda-forge/cantera
154149
:target: https://anaconda.org/conda-forge/cantera

doc/doxygen/versions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

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

9-
* [dev/latest](https://cantera.org/documentation/dev/doxygen/html/index.html) (unstable)
10-
* [v3.0.0](https://cantera.org/documentation/docs-3.0/doxygen/html/index.html)
11-
* [v2.6.0](https://cantera.org/documentation/docs-2.6/doxygen/html/modules.html)
12-
* [v2.5.1](https://cantera.org/documentation/docs-2.5/doxygen/html/modules.html)
13-
* [v2.4.0](https://cantera.org/documentation/docs-2.4/doxygen/html/modules.html)
14-
* [v2.3.0](https://cantera.org/documentation/docs-2.3/doxygen/html/modules.html)
15-
* [v2.2.1](https://cantera.org/documentation/docs-2.2/doxygen/html/modules.html)
16-
* [v2.1.2](https://cantera.org/documentation/docs-2.1/doxygen/html/modules.html)
17-
* [v2.0.2](https://cantera.org/documentation/docs-2.0/doxygen/html/modules.html)
9+
* [dev/latest](https://cantera.org/dev/cxx/index.html) (unstable)
10+
* [v3.0.0](https://cantera.org/3.0/doxygen/html/index.html)
11+
* [v2.6.0](https://cantera.org/2.6/doxygen/html/modules.html)
12+
* [v2.5.1](https://cantera.org/2.5/doxygen/html/modules.html)
13+
* [v2.4.0](https://cantera.org/2.4/doxygen/html/modules.html)
14+
* [v2.3.0](https://cantera.org/2.3/doxygen/html/modules.html)
15+
* [v2.2.1](https://cantera.org/2.2/doxygen/html/modules.html)
16+
* [v2.1.2](https://cantera.org/2.1/doxygen/html/modules.html)
17+
* [v2.0.2](https://cantera.org/2.0/doxygen/html/modules.html)

doc/sphinx/reference/releasenotes/v2.2.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ Published on June 5, 2015 | [Full release on GitHub](https://github.com/Cantera/
1212
New major version. Highlights include:
1313

1414
- Reformulated multicomponent diffusion calculation to improve 1D solver convergence.
15-
- 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).
15+
- 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).
1616
- 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.
17-
- 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).
18-
- 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).
19-
- 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)).
20-
- 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)).
21-
- 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)).
17+
- 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).
18+
- 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).
19+
- Efficient sensitivity analysis of 1D flame solutions (see [`flamespeed_sensitivity.py`](https://cantera.org/2.2/sphinx/html/cython/examples/onedim_flamespeed_sensitivity.html)).
20+
- 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)).
21+
- 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)).
2222
- Allow Sundials to link to external (optimized) BLAS/LAPACK libraries.
2323
- Support for Sundials 2.6.
24-
- Updated Matlab toolbox documentation, which is included in the [online HTML documentation](https://cantera.org/documentation/docs-2.2/sphinx/html/matlab/index.html).
24+
- Updated Matlab toolbox documentation, which is included in the [online HTML documentation](https://cantera.org/2.2/sphinx/html/matlab/index.html).
2525

2626
## Downloads available
2727

28-
- 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).
29-
- 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.
30-
- 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)
31-
- OS X Homebrew formula; see [installation instructions](https://cantera.org/documentation/docs-2.2/sphinx/html/install.html#mac-os-x)
28+
- 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).
29+
- 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.
30+
- 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)
31+
- OS X Homebrew formula; see [installation instructions](https://cantera.org/2.2/sphinx/html/install.html#mac-os-x)

doc/sphinx/reference/releasenotes/v2.3.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Published on January 19, 2017 | [Full release on GitHub](https://github.com/Cant
44

55
## Installation Options
66

7-
- 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.
8-
- 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.
9-
- 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).
10-
- Homebrew formula for macOS. See [additonal instructions](https://cantera.org/documentation/docs-2.3/sphinx/html/install.html#homebrew).
11-
- Download and compile the source code. Full instructions [here](https://cantera.org/documentation/docs-2.3/sphinx/html/compiling/index.html).
7+
- 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.
8+
- 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.
9+
- 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).
10+
- Homebrew formula for macOS. See [additonal instructions](https://cantera.org/2.3/sphinx/html/install.html#homebrew).
11+
- Download and compile the source code. Full instructions [here](https://cantera.org/2.3/sphinx/html/compiling/index.html).
1212

1313
## Documentation
1414

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

1717
## Changes in Cantera 2.3.0
1818

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

0 commit comments

Comments
 (0)