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

Document requirements of Python examples #755

Closed
speth opened this issue Nov 18, 2019 · 1 comment
Closed

Document requirements of Python examples #755

speth opened this issue Nov 18, 2019 · 1 comment

Comments

@speth
Copy link
Member

speth commented Nov 18, 2019

The examples shown at https://cantera.org/examples/python/index.html do not list the required version of Cantera or other dependencies. This leads to problems when users try to run them with incompatible versions of Cantera (see #728). A standard method for documenting these requirements was established in #729, and implemented for the ic_engine.py example, adding the line:

Requires: Cantera >= 2.5.0, scipy >= 0.19, matplotlib >= 2.0

to the script's docstring.

Similar Requires: sections should be added to the other Python examples. To simplify determining the appropriate minimum versions, I would suggest:

  • the only Cantera versions that need to be checked are 2.4.0 and 2.5.0
  • Cantera dependencies such as NumPy do not need to be documented unless an especially new version is required
  • The minimum version of other dependencies can be just the minimum tested version, rather than having to install very old versions just for the sake of testing
@bryanwweber
Copy link
Member

I believe this was completed in #768

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants