Skip to content

Science section re-org #146

@decaluwe

Description

@decaluwe

Abstract
I'd like to document my thoughts for next steps in reorganizing the website's Science section.

  1. Add some more content to the Transport landing page. My sense is that we can cover what we need to on a single page, without going into separate phase and species pages like we do for thermo, and without adding any other structure (e.g. cards), but we'll see, once it is in place.
  2. I plan to populate the phase-thermo, species-thermo, and kinetics pages with a bit more structure so that visitors to the website can more easily navigate to find what they want. My current plan is to use cards.
    Once item 2 is in place, resolving issues such as Add information on derivative calculation to science section cantera-website#169, Electrochemical Reactions missing from Science Section cantera-website#172, or New section for Equation of state documentation in the Science section cantera-website#174 should be pretty straightforward.
  3. This will also require some higher-level thinking about a) how to organize the content, and b) looking at the thermo models and deciding if there are any we want to drop (due to redundant functionalities, for example). as mentioned in Verify, catalog, and document Cantera ThermoPhase classes. #6.
    A brief description of the work being done.

Motivation

Describe the need for the work being done:

  • Prominent users have noted that it is incredibly difficult, at present, to find any documentation of the scientific theory applied in the Cantera classes.
  • At present, the easiest method for this is to scan the source code itself and locate the correct equations. This is both challenging to do, and an unnecessary hurdle.

Description

  • The changes here will provide a convenient way for users to inspect and understand the theory that is applied in the codebase. Ideally, the details will link to the codebase and other implementation details, as appropriate.
  • The first step involves a reformatting of the science section, to define and provide a structure for the significant amount of detail that this will entail.

References
The just merged Cantera/cantera-website#179 is the first step in this process.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationwork-in-progressAn enhancement that someone is currently working on

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions