mirror of
https://github.com/ANL-CEEESA/LLEPE.git
synced 2025-12-06 01:48:53 -06:00
rename for rtd
This commit is contained in:
titusquah
61
docs/_build/html/_sources/guide/about.rst.txt
vendored
Normal file
61
docs/_build/html/_sources/guide/about.rst.txt
vendored
Normal 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. 107–120, 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.
|
||||
***************************************************************************************************
|
||||
@@ -24,17 +24,17 @@ To install the latest master version:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install git+https://xgitlab.cels.anl.gov/summer-2020/parameter-estimation.git
|
||||
pip install git+https://github.com/ANL-CEEESA/LLEPE.git
|
||||
|
||||
|
||||
Development version
|
||||
===================
|
||||
|
||||
To contribute to Stable-Baselines, with support for running tests and building the documentation.
|
||||
To contribute to LLEPE, with support for running tests and building the documentation.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://xgitlab.cels.anl.gov/summer-2020/parameter-estimation.git && cd parameter-estimation
|
||||
git clone https://github.com/ANL-CEEESA/LLEPE.git
|
||||
pip install -e .[docs,tests]
|
||||
|
||||
|
||||
|
||||
12
docs/_build/html/_sources/index.rst.txt
vendored
12
docs/_build/html/_sources/index.rst.txt
vendored
@@ -1,9 +1,8 @@
|
||||
.. reeps documentation master file, created by Titus Quah
|
||||
sphinx-quickstart on Tue Jun 9 10:13:23 2020.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
.. LLEPE: Liquid-Liquid Equilibrium Parameter Estimator
|
||||
Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
|
||||
Released under the modified BSD license. See LICENSE for more details.
|
||||
|
||||
Welcome to llepe's docs! - the Liquid-Liquid Extraction Parameter Estimator
|
||||
Welcome to LLEPE's docs! - the Liquid-Liquid Extraction Parameter Estimator
|
||||
===========================================================================
|
||||
LLEPE is a package for thermodynamic parameter estimation for liquid-liquid extraction modeling
|
||||
|
||||
@@ -19,12 +18,13 @@ Error between predicted and experimental data is then minimized.
|
||||
|
||||
guide/install
|
||||
guide/quickstart
|
||||
guide/about
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Searchers
|
||||
|
||||
modules/reeps
|
||||
modules/LLEPE
|
||||
|
||||
|
||||
|
||||
|
||||
15
docs/_build/html/_sources/modules/LLEPE.rst.txt
vendored
Normal file
15
docs/_build/html/_sources/modules/LLEPE.rst.txt
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _LLEPE:
|
||||
|
||||
.. automodule:: llepe
|
||||
|
||||
LLEPE
|
||||
=====
|
||||
|
||||
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
.. autoclass:: LLEPE
|
||||
:members:
|
||||
:inherited-members:
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _reeps:
|
||||
.. _LLEPE:
|
||||
|
||||
.. automodule:: llepe
|
||||
|
||||
|
||||
Reference in New Issue
Block a user