Skip to content

Commit

Permalink
cleanup links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wpk committed Mar 30, 2023
1 parent ba8ad22 commit 3a1784c
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 24 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can contribute in many ways:

### Report Bugs

Report bugs at <https://github.com/usnistgov/thermoextrap/issues>.
Report bugs at <https://github.com/usnistgov/thermo-extrap/issues>.

If you are reporting a bug, please include:

Expand All @@ -35,7 +35,7 @@ articles, and such.

### Submit Feedback

The best way to send feedback is to file an issue at <https://github.com/usnistgov/thermoextrap/issues>.
The best way to send feedback is to file an issue at <https://github.com/usnistgov/thermo-extrap/issues>.

If you are proposing a feature:

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
13 changes: 3 additions & 10 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/notebooks/gpr/analysis_adsorption.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1302,7 +1302,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Maximum variance"
"### Maximum variance active learning"
]
},
{
Expand Down Expand Up @@ -1616,7 +1616,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Space-filling"
"### Space-filling active learning"
]
},
{
Expand Down Expand Up @@ -1773,7 +1773,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Comparison"
"### Comparison active learning"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/gpr/analysis_polymer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Nice figures"
"### Nice figures 1"
]
},
{
Expand Down Expand Up @@ -915,7 +915,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Nice figures"
"### Nice figures 2"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions src/thermoextrap/adaptive_interp.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
11 changes: 7 additions & 4 deletions src/thermoextrap/core/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ def deriv_args(cls):
See Also
--------
sympy.lambdify
sympy.utilities.lambdify.lambdify
"""
raise NotImplementedError("must specify in sublcass")

Expand Down Expand Up @@ -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()
Expand Down

0 comments on commit 3a1784c

Please sign in to comment.