commit that fixes readthedocs

docs/conf.py

@@ -1,7 +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
@@ -17,7 +16,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------
 
@@ -25,7 +24,6 @@ project = 'LLEPE'
 copyright = '2020, UChicago Argonne, LLC.'
 author = 'UChicago Argonne, LLC.'
 master_doc = 'index'
-autodoc_mock_imports = ["cantera"]
 
 # The full version, including alpha/beta/rc tags
 release = '1.0.0'

docs/guide/about.rst

@@ -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.
+    ***************************************************************************************************

docs/guide/install.rst

@@ -30,11 +30,11 @@ To install the latest master version:
 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://github.com/titusquah/LLEPE.git && cd LLEPE
+    git clone https://github.com/ANL-CEEESA/LLEPE.git
     pip install -e .[docs,tests]
 
 

docs/index.rst

@@ -22,7 +22,7 @@ Error between predicted and experimental data is then minimized.
    
 .. toctree::
    :maxdepth: 1
-   :caption: Estimators
+   :caption: Searchers
    
    modules/LLEPE
    

docs/modules/LLEPE.rst

@@ -1,4 +1,4 @@
-.. _reeps:
+.. _LLEPE:
 
 .. automodule:: llepe
 

docs/requirements.txt

@@ -1,5 +0,0 @@
-matplotlib
-datetime
-pandas
-numpy
-scipy