From 3a1784c4dd7612a431347b5180a191e95daf23e3 Mon Sep 17 00:00:00 2001 From: wpk Date: Thu, 30 Mar 2023 19:56:22 -0400 Subject: [PATCH] cleanup links in docs --- CONTRIBUTING.md | 4 ++-- docs/conf.py | 2 +- docs/installation.md | 13 +++---------- docs/notebooks/gpr/analysis_adsorption.ipynb | 6 +++--- docs/notebooks/gpr/analysis_polymer.ipynb | 4 ++-- src/thermoextrap/adaptive_interp.py | 4 ++-- src/thermoextrap/core/models.py | 11 +++++++---- 7 files changed, 20 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfcc665b..58b82935 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ You can contribute in many ways: ### Report Bugs -Report bugs at . +Report bugs at . If you are reporting a bug, please include: @@ -35,7 +35,7 @@ articles, and such. ### Submit Feedback -The best way to send feedback is to file an issue at . +The best way to send feedback is to file an issue at . If you are proposing a feature: diff --git a/docs/conf.py b/docs/conf.py index 5a9dfb7f..e2712b09 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -261,7 +261,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/installation.md b/docs/installation.md index 94ca0e78..bec73477 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -44,20 +44,13 @@ The sources for thermodynamic-extrapolation can be downloaded from the [Github r You can either clone the public repository: ```console -$ git clone git://github.com/wpk-nist-gov/thermoextrap -``` - -Or download the [tarball]: - -```console -$ curl -OJL https://github.com/wpk-nist-gov/thermoextrap/tarball/master +$ git clone git://github.com/usnistgov/thermo-extrap.git ``` Once you have a copy of the source, you can install it with: ```console -$ python setup.py install +$ pip install . ``` -[github repo]: https://github.com/wpk-nist-gov/thermoextrap -[tarball]: https://github.com/wpk-nist-gov/thermoextrap/tarball/master +[github repo]: https://github.com/usnistgov/thermo-extrap diff --git a/docs/notebooks/gpr/analysis_adsorption.ipynb b/docs/notebooks/gpr/analysis_adsorption.ipynb index 40b675e0..c400af11 100644 --- a/docs/notebooks/gpr/analysis_adsorption.ipynb +++ b/docs/notebooks/gpr/analysis_adsorption.ipynb @@ -1302,7 +1302,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Maximum variance" + "### Maximum variance active learning" ] }, { @@ -1616,7 +1616,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Space-filling" + "### Space-filling active learning" ] }, { @@ -1773,7 +1773,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Comparison" + "### Comparison active learning" ] }, { diff --git a/docs/notebooks/gpr/analysis_polymer.ipynb b/docs/notebooks/gpr/analysis_polymer.ipynb index 8b986503..e193c62d 100644 --- a/docs/notebooks/gpr/analysis_polymer.ipynb +++ b/docs/notebooks/gpr/analysis_polymer.ipynb @@ -554,7 +554,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Nice figures" + "### Nice figures 1" ] }, { @@ -915,7 +915,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Nice figures" + "### Nice figures 2" ] }, { diff --git a/src/thermoextrap/adaptive_interp.py b/src/thermoextrap/adaptive_interp.py index 5dff5057..c8d1ba78 100644 --- a/src/thermoextrap/adaptive_interp.py +++ b/src/thermoextrap/adaptive_interp.py @@ -152,7 +152,7 @@ def train_iterative( alpha_tol : float, default=0.01 new states must have `abs(alpha_new - alpha) > alpha_tol` for all existing states. callback : callable - stop = callback(model, alphas, info_dict, **callback_kws). + `stop = callback(model, alphas, info_dict, **callback_kws)`. If callback returns something that evaluates True, then the iteration stops. * model : current model. * alphas : sequence of alphas @@ -291,7 +291,7 @@ def train_recursive( alpha_tol : float, default=0.01 new states must have `abs(alpha_new - alpha) > alpha_tol` for all existing states. callback : callable - stop = callback(model, alphas, info_dict, **callback_kws). + `stop = callback(model, alphas, info_dict, **callback_kws)`. If callback returns something that evaluates True, then the iteration stops. `model` is the current model. `alphas` is the sequence of alphas diff --git a/src/thermoextrap/core/models.py b/src/thermoextrap/core/models.py index e5953f4c..784f0221 100644 --- a/src/thermoextrap/core/models.py +++ b/src/thermoextrap/core/models.py @@ -73,8 +73,7 @@ def deriv_args(cls): See Also -------- - sympy.lambdify - + sympy.utilities.lambdify.lambdify """ raise NotImplementedError("must specify in sublcass") @@ -211,11 +210,15 @@ class Lambdify: Parameters ---------- exprs : sequence of symFunction - array of sympy expressions to :func:`~sympy.utilities.lambdify` + array of sympy expressions to ``lambdify`` args : sequence of Symbol array of symbols which will be in args of the resulting function lambdify_kws : dict - extra arguments to :func:`~sympy.utilities.lambdify` + extra arguments to ``lambdify`` + + See Also + -------- + sympy.utilities.lambdify.lambdify """ exprs: Sequence[sp.Function] = field()