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

doc: hydrogen combustion example blank page removed #518

Merged
merged 2 commits into from
May 19, 2018

Conversation

vdevgan
Copy link
Contributor

@vdevgan vdevgan commented Mar 24, 2018

Changes proposed in this pull request:

  • "hydrogen combustion reaction " page in doc was empty.
    that has been removed.

@bryanwweber
Copy link
Member

This is being tracked in #313, where the solution is to add the example rather than removing the page

@vdevgan
Copy link
Contributor Author

vdevgan commented Mar 26, 2018

could I be shown another example in the doc or elsewhere to know in what specific format is the example to be filled?

@bryanwweber
Copy link
Member

The example in question is on pg. 55 of the PDF linked in #313. Other examples can be found in https://github.com/Cantera/cantera/tree/master/interfaces/cython/cantera/examples for Python and https://github.com/Cantera/cantera/tree/master/samples/matlab for Matlab. Note that the script in the PDF is a Matlab script, but we would prefer to have either Python or both Python and Matlab. You can also directly use the h2o2.xml file as the chemistry file, rather than a subset of GRI-3.0 as in the PDF.

@speth
Copy link
Member

speth commented May 14, 2018

I'm inclined to accept the solution of just removing the blank page, since it's not clear that those examples really belong as part of the CTI documentation anyway. The only change needed to this PR is that the entry in index.rst also needs to be removed. Issue #313 should remain open as a reminder that those examples have not been migrated.

combustion example reference from the file has been removed.
@vdevgan
Copy link
Contributor Author

vdevgan commented May 19, 2018

combustion example reference from cti/ index.rst has been removed.

@codecov
Copy link

codecov bot commented May 19, 2018

Codecov Report

Merging #518 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #518      +/-   ##
==========================================
+ Coverage   64.78%   64.78%   +<.01%     
==========================================
  Files         383      383              
  Lines       40734    40736       +2     
==========================================
+ Hits        26390    26392       +2     
  Misses      14344    14344
Impacted Files Coverage Δ
src/base/stringUtils.cpp 74.8% <0%> (ø) ⬆️
src/equil/ChemEquil.cpp 75.75% <0%> (+0.03%) ⬆️
include/cantera/cython/wrappers.h 87.03% <0%> (+0.24%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39c4103...4ecfb2b. Read the comment docs.

@speth speth merged commit 84acdb1 into Cantera:master May 19, 2018
srikanthallu pushed a commit to srikanthallu/cantera that referenced this pull request Sep 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants