From 93811ee254a3913c7258f040b66dacf5215ae689 Mon Sep 17 00:00:00 2001 From: titusquah <46580668+titusquah@users.noreply.github.com> Date: Wed, 7 Apr 2021 11:43:17 -0600 Subject: [PATCH] updated _source --- docs/_source/conf.py | 3 + docs/_source/guide/about.rst | 61 +++++++++++++++++++ docs/_source/guide/install.rst | 6 +- docs/_source/index.rst | 3 +- docs/_source/modules/{reeps.rst => LLEPE.rst} | 2 +- 5 files changed, 70 insertions(+), 5 deletions(-) create mode 100644 docs/_source/guide/about.rst rename docs/_source/modules/{reeps.rst => LLEPE.rst} (74%) diff --git a/docs/_source/conf.py b/docs/_source/conf.py index 98dbabd..a32a0d1 100644 --- a/docs/_source/conf.py +++ b/docs/_source/conf.py @@ -1,3 +1,6 @@ +# 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. # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full diff --git a/docs/_source/guide/about.rst b/docs/_source/guide/about.rst new file mode 100644 index 0000000..dbd1116 --- /dev/null +++ b/docs/_source/guide/about.rst @@ -0,0 +1,61 @@ +.. _about: + +************ +About +************ + +Authors +============= +Titus Quah, University of Utah, + +Nwike Iloeje, Argonne National Laboratory, + +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. + *************************************************************************************************** diff --git a/docs/_source/guide/install.rst b/docs/_source/guide/install.rst index ce1a1f9..e7306d7 100644 --- a/docs/_source/guide/install.rst +++ b/docs/_source/guide/install.rst @@ -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] diff --git a/docs/_source/index.rst b/docs/_source/index.rst index 826ce9f..a0c905b 100644 --- a/docs/_source/index.rst +++ b/docs/_source/index.rst @@ -18,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 diff --git a/docs/_source/modules/reeps.rst b/docs/_source/modules/LLEPE.rst similarity index 74% rename from docs/_source/modules/reeps.rst rename to docs/_source/modules/LLEPE.rst index bba5c13..41daa9d 100644 --- a/docs/_source/modules/reeps.rst +++ b/docs/_source/modules/LLEPE.rst @@ -1,4 +1,4 @@ -.. _reeps: +.. _LLEPE: .. automodule:: llepe