Skip to content

Commit

Permalink
Added linking with core docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmkenney committed Nov 8, 2023
1 parent bcdb98b commit b98879a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ensembles described in :footcite:p:`LindorffLarsen2009`. The implementation and
are described in :footcite:p:`Tiberti2015`.

The module includes facilities for handling ensembles and trajectories through
the :class:`Universe` class, performing clustering or dimensionality reduction
the :class:`~MDAnalysis.core.universe.Universe` class, performing clustering or dimensionality reduction
of the ensemble space, estimating multivariate probability distributions from
the input data, and more. ENCORE can be used to compare experimental and
simulation-derived ensembles, as well as estimate the convergence of
Expand Down
8 changes: 4 additions & 4 deletions mdaencore/similarity.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
described in :footcite:p:`Tiberti2015`.
The module includes facilities for handling ensembles and trajectories through
the :class:`Universe` class, performing clustering or dimensionality reduction
the :class:`~MDAnalysis.core.universe.Universe` class, performing clustering or dimensionality reduction
of the ensemble space, estimating multivariate probability distributions from
the input data, and more. ENCORE can be used to compare experimental and
simulation-derived ensembles, as well as estimate the convergence of
Expand Down Expand Up @@ -1051,7 +1051,7 @@ def ces(ensembles,
(Note that the sklearn module must be installed). Likewise, different parameters
for the same clustering method can be explored by adding different
instances of the same clustering class.
Here the simplest case of just two instances of :class:`Universe` is illustrated:
Here the simplest case of just two instances of :class:`~MDAnalysis.core.universe.Universe` is illustrated:
>>> from MDAnalysis import Universe
>>> import mdaencore as encore
Expand Down Expand Up @@ -1326,7 +1326,7 @@ def dres(ensembles,
parameter dimensionality_reduction_method. Likewise, different parameters
for the same clustering method can be explored by adding different
instances of the same method class.
Here the simplest case of comparing just two instances of :class:`Universe` is
Here the simplest case of comparing just two instances of :class:`~MDAnalysis.core.universe.Universe` is
illustrated:
>>> from MDAnalysis import Universe
Expand All @@ -1341,7 +1341,7 @@ def dres(ensembles,
In addition to the quantitative similarity estimate, the dimensional
reduction can easily be visualized, see the ``Example`` section in
:mod:`mdaencore.dimensionality_reduction.reduce_dimensionality``
:mod:`mdaencore.dimensionality_reduction.reduce_dimensionality`
"""

Expand Down

0 comments on commit b98879a

Please sign in to comment.