Skip to content

Commit

Permalink
Update write_thermo_yaml docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wittregr committed Apr 21, 2024
1 parent 220366c commit 1cee0e2
Show file tree
Hide file tree
Showing 158 changed files with 224 additions and 5 deletions.
Binary file modified .doctrees/api/constants/constants.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.Na.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.P0.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.R.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.T0.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.V0.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.c.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.e.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.h.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.kb.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.m_e.doctree
Binary file not shown.
Binary file modified .doctrees/api/constants/constants/pmutt.constants.m_p.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/constants/misc/pmutt.constants.prefixes.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/constants/misc/pmutt.constants.type_dict.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/empirical/empirical.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/empirical/nasa/pmutt.empirical.nasa.Nasa.doctree
Binary file not shown.
Binary file modified .doctrees/api/empirical/nasa/pmutt.empirical.nasa.Nasa9.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/eos/eos.doctree
Binary file not shown.
Binary file modified .doctrees/api/eos/eos/pmutt.eos.IdealGasEOS.doctree
Binary file not shown.
Binary file modified .doctrees/api/eos/eos/pmutt.eos.vanDerWaalsEOS.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/equilibrium/equilibrium.doctree
Binary file not shown.
Binary file modified .doctrees/api/helper/helper.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/chemkin/pmutt.io.chemkin.read_reactions.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/chemkin/pmutt.io.chemkin.write_EA.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/chemkin/pmutt.io.chemkin.write_T_flow.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/chemkin/pmutt.io.chemkin.write_gas.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/chemkin/pmutt.io.chemkin.write_surf.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.read_excel.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_atoms.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_dict_value.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_elec_model.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_element.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_formula.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_list_value.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_nasa_a_high.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_nasa_a_low.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_nucl_model.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_rot_model.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_statmech_model.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_trans_model.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/excel/pmutt.io.excel.set_vib_model.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/gaussian/pmutt.io.gaussian.read_pattern.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/gaussian/pmutt.io.gaussian.read_zpe.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/io.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/json/pmutt.io.json.json_to_pmutt.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/json/pmutt.io.json.pmuttEncoder.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/omkm/pmutt.io.omkm.get_reactions_phases.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/omkm/pmutt.io.omkm.get_species_phases.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/omkm/pmutt.io.omkm.organize_phases.doctree
Binary file not shown.
Binary file modified .doctrees/api/io/omkm/pmutt.io.omkm.write_cti.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/io/omkm/pmutt.io.omkm.write_yaml.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/kinetic_models/kinetic_models.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/mixture/mixture.doctree
Binary file not shown.
Binary file modified .doctrees/api/phase_diagram/phase_diagram.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/reactions/bep/pmutt.omkm.reaction.BEP.doctree
Binary file not shown.
Binary file modified .doctrees/api/reactions/bep/pmutt.reaction.bep.BEP.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/reactions/reaction/pmutt.reaction.Reaction.doctree
Binary file not shown.
Binary file modified .doctrees/api/reactions/reactions.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/statmech/elec/pmutt.statmech.lsr.ExtendedLSR.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/elec/pmutt.statmech.lsr.LSR.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/misc/pmutt.statmech.ConstantMode.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/misc/pmutt.statmech.EmptyMode.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/statmech/rot/pmutt.statmech.rot.RigidRotor.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/statmech.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/statmech/pmutt.statmech.StatMech.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/statmech/vib/pmutt.statmech.vib.DebyeVib.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/api/statmech/vib/pmutt.statmech.vib.HarmonicVib.doctree
Binary file not shown.
Binary file modified .doctrees/api/statmech/vib/pmutt.statmech.vib.QRRHOVib.doctree
Binary file not shown.
Binary file modified .doctrees/api/visualization/visual.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/examples_jupyter/examples.doctree
Binary file not shown.
Binary file modified .doctrees/includeme.doctree
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file modified .doctrees/install.doctree
Binary file not shown.
Binary file modified .doctrees/publications.doctree
Binary file not shown.
Binary file modified .doctrees/referencing.doctree
Binary file not shown.
Binary file modified .doctrees/release_notes.doctree
Binary file not shown.
Binary file modified .doctrees/workshops/aiche_2019.doctree
Binary file not shown.
Binary file modified .doctrees/workshops/nam_2019.doctree
Binary file not shown.
Binary file modified .doctrees/workshops/polimi_2020.doctree
Binary file not shown.
Binary file modified .doctrees/workshops/workshops.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions _sources/api/io/io.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ OpenMKM

omkm.write_cti
omkm.write_yaml
omkm.write_thermo_yaml
omkm.get_species_phases
omkm.get_reactions_phases
omkm.get_interactions_phases
Expand Down
6 changes: 6 additions & 0 deletions _sources/api/io/omkm/pmutt.io.omkm.write_thermo_yaml.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pmutt.io.omkm.write\_thermo\_yaml
=================================

.. currentmodule:: pmutt.io.omkm

.. autofunction:: write_thermo_yaml
12 changes: 8 additions & 4 deletions api/io/io.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@
<li class="toctree-l2"><a class="reference internal" href="#openmkm">OpenMKM</a><ul>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.write_cti.html">pmutt.io.omkm.write_cti</a></li>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.write_yaml.html">pmutt.io.omkm.write_yaml</a></li>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.write_thermo_yaml.html">pmutt.io.omkm.write_thermo_yaml</a></li>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.get_species_phases.html">pmutt.io.omkm.get_species_phases</a></li>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.get_reactions_phases.html">pmutt.io.omkm.get_reactions_phases</a></li>
<li class="toctree-l3"><a class="reference internal" href="omkm/pmutt.io.omkm.get_interactions_phases.html">pmutt.io.omkm.get_interactions_phases</a></li>
Expand Down Expand Up @@ -546,16 +547,19 @@ <h2>OpenMKM<a class="headerlink" href="#openmkm" title="Permalink to this headin
<tr class="row-even"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.write_yaml.html#pmutt.io.omkm.write_yaml" title="pmutt.io.omkm.write_yaml"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.write_yaml</span></code></a></p></td>
<td><p>Writes the reactor options in a YAML file for OpenMKM.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_species_phases.html#pmutt.io.omkm.get_species_phases" title="pmutt.io.omkm.get_species_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_species_phases</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="omkm/pmutt.io.omkm.write_thermo_yaml.html#pmutt.io.omkm.write_thermo_yaml" title="pmutt.io.omkm.write_thermo_yaml"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.write_thermo_yaml</span></code></a></p></td>
<td><p>Writes the units, phases, species, lateral interactions, reactions and additional options in the CTI format for OpenMKM</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_species_phases.html#pmutt.io.omkm.get_species_phases" title="pmutt.io.omkm.get_species_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_species_phases</span></code></a></p></td>
<td><p>Helper method to organize species into its phases</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_reactions_phases.html#pmutt.io.omkm.get_reactions_phases" title="pmutt.io.omkm.get_reactions_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_reactions_phases</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_reactions_phases.html#pmutt.io.omkm.get_reactions_phases" title="pmutt.io.omkm.get_reactions_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_reactions_phases</span></code></a></p></td>
<td><p>Helper method to organize reaction into its phases</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_interactions_phases.html#pmutt.io.omkm.get_interactions_phases" title="pmutt.io.omkm.get_interactions_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_interactions_phases</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.get_interactions_phases.html#pmutt.io.omkm.get_interactions_phases" title="pmutt.io.omkm.get_interactions_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.get_interactions_phases</span></code></a></p></td>
<td><p>Helper method to organize reaction into its phases</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.organize_phases.html#pmutt.io.omkm.organize_phases" title="pmutt.io.omkm.organize_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.organize_phases</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../kinetic_models/omkm/pmutt.io.omkm.organize_phases.html#pmutt.io.omkm.organize_phases" title="pmutt.io.omkm.organize_phases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omkm.organize_phases</span></code></a></p></td>
<td><p>Helper method to organize phase data for OpenMKM</p></td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit 1cee0e2

Please sign in to comment.