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

Location of input files used in Jupyter examples is not obvious #148

Closed
speth opened this issue Jun 14, 2021 · 1 comment · Fixed by #171
Closed

Location of input files used in Jupyter examples is not obvious #148

speth opened this issue Jun 14, 2021 · 1 comment · Fixed by #171
Labels
documentation-update An update is needed to the documentation

Comments

@speth
Copy link
Member

speth commented Jun 14, 2021

If a user starts from a Jupyter example shown on the Cantera website, e.g. https://cantera.org/examples/jupyter/reactors/1D_pfr_surfchem.ipynb.html, that requires an input file that's not distributed with the Cantera Python module, it's really not clear where the user should look to find these input files. Some information on the landing page (https://cantera.org/examples/jupyter/index.html) would be a start, but I think it would be even better to provide links to these input files on the pages with the individual examples.

This issue was identified as part of a discussion on the Users' Group.

@ischoegl
Copy link
Member

I think that would be a great idea. It may make sense to collect all data files in the root folder of the jupyter repo (after conversion to YAML), which would make it easier to point to just one location.

@bryanwweber bryanwweber added the documentation-update An update is needed to the documentation label Dec 6, 2021
speth added a commit to speth/cantera-website that referenced this issue Jan 17, 2022
speth added a commit to speth/cantera-jupyter that referenced this issue Jan 17, 2022
@speth speth linked a pull request Jan 17, 2022 that will close this issue
bryanwweber pushed a commit to speth/cantera-jupyter that referenced this issue Feb 20, 2022
bryanwweber pushed a commit to Cantera/cantera-jupyter that referenced this issue Feb 20, 2022
speth added a commit to speth/cantera-website that referenced this issue Mar 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-update An update is needed to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants