mirror of https://github.com/ANL-CEEESA/LLEPE
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
250 lines
10 KiB
250 lines
10 KiB
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="python" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="python" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Getting Started — LLEPE 1.0.0 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
<script src="../_static/jquery.js"></script>
|
|
<script src="../_static/underscore.js"></script>
|
|
<script src="../_static/doctools.js"></script>
|
|
<script src="../_static/language_data.js"></script>
|
|
|
|
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="LLEPE" href="../modules/reeps.html" />
|
|
<link rel="prev" title="Installation" href="install.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home"> LLEPE
|
|
|
|
|
|
|
|
|
|
<img src="../_static/logo.png" class="logo" alt="Logo"/>
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="caption"><span class="caption-text">User Guide</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a></li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Searchers</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../modules/reeps.html">LLEPE</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">LLEPE</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../index.html">Docs</a> »</li>
|
|
|
|
<li>Getting Started</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="../_sources/guide/quickstart.rst.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="getting-started">
|
|
<span id="quickstart"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
|
|
<p>Here is a quick example of how to fit an xml thermodynamic model to experimental data.</p>
|
|
<p>This code fits Nd standard enthalpy in the "twophase.xml" cantera file to the
|
|
experimental data in "Nd_exp_data.csv".</p>
|
|
<p>This code requires that you copy and paste the "elementz.xml" file in the llepe's data folder into
|
|
the Cantera's data folder located in your environments site-packages folder.</p>
|
|
<p>The code then produces a parity plot of the measured and predicted concentrations of Nd 3+ in the
|
|
aqueous phase.</p>
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">llepe</span> <span class="kn">import</span> <span class="n">LLEPE</span>
|
|
<span class="n">opt_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Nd(H(A)2)3(org)_h0'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'upper_element_name'</span><span class="p">:</span> <span class="s1">'species'</span><span class="p">,</span>
|
|
<span class="s1">'upper_attrib_name'</span><span class="p">:</span> <span class="s1">'name'</span><span class="p">,</span>
|
|
<span class="s1">'upper_attrib_value'</span><span class="p">:</span> <span class="s1">'Nd(H(A)2)3(org)'</span><span class="p">,</span>
|
|
<span class="s1">'lower_element_name'</span><span class="p">:</span> <span class="s1">'h0'</span><span class="p">,</span>
|
|
<span class="s1">'lower_attrib_name'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="s1">'lower_attrib_value'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="s1">'input_format'</span><span class="p">:</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1">'</span><span class="p">,</span>
|
|
<span class="s1">'input_value'</span><span class="p">:</span> <span class="o">-</span><span class="mf">4.7e6</span><span class="p">}}</span>
|
|
|
|
<span class="n">searcher_parameters</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'exp_data'</span><span class="p">:</span> <span class="s1">'Nd_exp_data.csv'</span><span class="p">,</span>
|
|
<span class="s1">'phases_xml_filename'</span><span class="p">:</span> <span class="s1">'twophase.xml'</span><span class="p">,</span>
|
|
<span class="s1">'opt_dict'</span><span class="p">:</span> <span class="n">opt_dict</span><span class="p">,</span>
|
|
<span class="s1">'phase_names'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'HCl_electrolyte'</span><span class="p">,</span> <span class="s1">'PC88A_liquid'</span><span class="p">],</span>
|
|
<span class="s1">'aq_solvent_name'</span><span class="p">:</span> <span class="s1">'H2O(L)'</span><span class="p">,</span>
|
|
<span class="s1">'extractant_name'</span><span class="p">:</span> <span class="s1">'(HA)2(org)'</span><span class="p">,</span>
|
|
<span class="s1">'diluant_name'</span><span class="p">:</span> <span class="s1">'dodecane'</span><span class="p">,</span>
|
|
<span class="s1">'complex_names'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'Nd(H(A)2)3(org)'</span><span class="p">],</span>
|
|
<span class="s1">'extracted_species_ion_names'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'Nd+++'</span><span class="p">],</span>
|
|
<span class="s1">'aq_solvent_rho'</span><span class="p">:</span> <span class="mf">1000.0</span><span class="p">,</span>
|
|
<span class="s1">'extractant_rho'</span><span class="p">:</span> <span class="mf">960.0</span><span class="p">,</span>
|
|
<span class="s1">'diluant_rho'</span><span class="p">:</span> <span class="mf">750.0</span><span class="p">}</span>
|
|
<span class="n">searcher</span> <span class="o">=</span> <span class="n">LLEPE</span><span class="p">(</span><span class="o">**</span><span class="n">searcher_parameters</span><span class="p">)</span>
|
|
<span class="n">est_enthalpy</span> <span class="o">=</span> <span class="n">searcher</span><span class="o">.</span><span class="n">fit</span><span class="p">()</span>
|
|
<span class="n">searcher</span><span class="o">.</span><span class="n">update_xml</span><span class="p">(</span><span class="n">est_enthalpy</span><span class="p">)</span>
|
|
<span class="n">searcher</span><span class="o">.</span><span class="n">parity_plot</span><span class="p">(</span><span class="n">print_r_squared</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The code should return something like this</p>
|
|
<div class="figure align-default">
|
|
<img alt="../_images/quick_start_output.png" src="../_images/quick_start_output.png" />
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../modules/reeps.html" class="btn btn-neutral float-right" title="LLEPE" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="install.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2020, UChicago Argonne, LLC.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |