Skip to content

Make Cantera examples a submodule / consolidate with Jupyter #129

@ischoegl

Description

@ischoegl

Abstract

At the moment, Python examples are installed deep in the 'guts' of cantera, and thus are relatively hard to find. When installing from source, the installation location is also not consistent with other languages, see #51.

Beyond, there already is a separate Cantera/cantera-jupyter repository (as well as examples from workshops). These examples are currently not covered by CI testing.

One idea would be to create a dedicated repository for Cantera examples that can be cloned from GitHub. The repository should be included as a submodule in the main Cantera/cantera repo, so things are installed together when compiling from source and can be tested by CI (as already done at the moment).

Motivation

Describe the need for the proposed change:

  • What problem is it trying to solve? ... make examples easier to find / consolidate Jupyter and Python.
  • Who is affected by the change? ... anyone interested in examples
  • Why is this a good solution? ... consolidate different example locations and ensure that everything is covered by CI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions