Revert "deleted _build"

This reverts commit 6389ba6276.
This commit is contained in:
titusquah
2021-04-07 11:31:39 -06:00
parent 6389ba6276
commit 8b5ab69ea9
85 changed files with 22502 additions and 0 deletions

View File

@@ -0,0 +1,61 @@
.. _about:
************
About
************
Authors
=============
Titus Quah, University of Utah, <titus{dot}quah{at}gmail{dot}com>
Nwike Iloeje, Argonne National Laboratory, <ciloeje{at}anl{dot}gov>
Acknowledgements
================
Based upon work supported by funding from Argonne National Laboratory provided by the U.S. Department of Energy, Office of Energy Efficiency and Renewable Energy (EERE), under contract DE-AC02-06CH11357
References
==========
If you use LLEPE in your research , we kindly request that you cite the package as follows:
T. Quah and C. O. Iloeje, “Liquid--Liquid Extraction Thermodynamic Parameter Estimator (LLEPE) for Multicomponent Separation Systems,” in Materials Processing Fundamentals 2021, 2021, pp. 107120, doi: https://doi.org/10.1007/978-3-030-65253-1_9.
License
=======
::
Copyright © 2020, UChicago Argonne, LLC
All Rights Reserved
Software Name: LLEPE
By: Argonne National Laboratory, University of Utah
OPEN SOURCE LICENSE
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
******************************************************************************************************
DISCLAIMER
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
***************************************************************************************************

View File

@@ -0,0 +1,44 @@
.. _install:
************
Installation
************
Prerequisites
=============
LLEPE requires python3 (>=3.5) with the development headers.
Stable Release
==============
There is currently no stable release
Bleeding-edge version
=====================
To install the latest master version:
.. code-block:: bash
pip install git+https://github.com/ANL-CEEESA/LLEPE.git
Development version
===================
To contribute to LLEPE, with support for running tests and building the documentation.
.. code-block:: bash
git clone https://github.com/ANL-CEEESA/LLEPE.git
pip install -e .[docs,tests]
Using Docker Images
===================
Not set up yet.

View File

@@ -0,0 +1,49 @@
.. _quickstart:
***************
Getting Started
***************
Here is a quick example of how to fit an xml thermodynamic model to experimental data.
This code fits Nd standard enthalpy in the "twophase.xml" cantera file to the
experimental data in "Nd_exp_data.csv".
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.
The code then produces a parity plot of the measured and predicted concentrations of Nd 3+ in the
aqueous phase.
.. code-block:: python
from llepe import LLEPE
opt_dict = {'Nd(H(A)2)3(org)_h0': {'upper_element_name': 'species',
'upper_attrib_name': 'name',
'upper_attrib_value': 'Nd(H(A)2)3(org)',
'lower_element_name': 'h0',
'lower_attrib_name': None,
'lower_attrib_value': None,
'input_format': '{0}',
'input_value': -4.7e6}}
searcher_parameters = {'exp_data': 'Nd_exp_data.csv',
'phases_xml_filename': 'twophase.xml',
'opt_dict': opt_dict,
'phase_names': ['HCl_electrolyte', 'PC88A_liquid'],
'aq_solvent_name': 'H2O(L)',
'extractant_name': '(HA)2(org)',
'diluant_name': 'dodecane',
'complex_names': ['Nd(H(A)2)3(org)'],
'extracted_species_ion_names': ['Nd+++'],
'aq_solvent_rho': 1000.0,
'extractant_rho': 960.0,
'diluant_rho': 750.0}
searcher = LLEPE(**searcher_parameters)
est_enthalpy = searcher.fit()
searcher.update_xml(est_enthalpy)
searcher.parity_plot(print_r_squared=True)
The code should return something like this
.. figure:: ../_static/img/quick_start_output.png