Skip to content

Commit bd83b01

Browse files
author
github-actions
committed
rebuilt html docs for version 2.9.0-dev0 from branch develop with sphinx at 50cbb8a
1 parent 7860b11 commit bd83b01

File tree

46 files changed

+244
-248
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+244
-248
lines changed
Binary file not shown.

2.9.0-dev0/_sources/contributing.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Some great resources for learning Git:
7575

7676
* the `GitHub help pages <http://help.github.com/>`_.
7777
* the `NumPy's documentation <http://docs.scipy.org/doc/numpy/dev/index.html>`_.
78-
* Matthew Brett's `Pydagogue <http://matthew-brett.github.com/pydagogue/>`_.
78+
* Matthew Brett's `Pydagogue <https://matthew-brett.github.io/pydagogue/>`_.
7979

8080
------------------------
8181
Getting started with Git

2.9.0-dev0/_sources/examples/analysis/alignment_and_rms/README.rst.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The :mod:`MDAnalysis.analysis.align` and :mod:`MDAnalysis.analysis.rms`
1010
modules contain the functions used for aligning structures,
1111
aligning trajectories, and calculating root mean squared quantities.
1212

13-
Demonstrations of alignment are in `align_structure`_,
14-
`align_trajectory_first`_, and `align_trajectory`_. Another example of
13+
Demonstrations of alignment are in `align_structure <aligning_structure_to_another.ipynb>`__,
14+
`align_trajectory_first <aligning_trajectory_to_frame.ipynb>`__, and `align_trajectory <aligning_trajectory.ipynb>`__. Another example of
1515
generating an average structure from an alignment is demonstrated in
16-
`rmsf`_. Typically, trajectories need to be aligned for RMSD and
16+
`rmsf <rmsf.ipynb>`__. Typically, trajectories need to be aligned for RMSD and
1717
RMSF values to make sense.
1818

1919
.. note::
@@ -33,10 +33,8 @@ RMSF values to make sense.
3333
/examples/analysis/alignment_and_rms/pairwise_rmsd
3434
/examples/analysis/alignment_and_rms/rmsf
3535

36-
37-
.. _align_structure: /examples/analysis/alignment_and_rms/aligning_structure_to_another.ipynb
38-
.. _align_trajectory_first: /examples/analysis/alignment_and_rms/aligning_trajectory_to_first_frame.ipynb
39-
.. _align_trajectory: /examples/analysis/alignment_and_rms/aligning_trajectory.ipynb
4036
.. _rmsd: /examples/analysis/alignment_and_rms/rmsd.ipynb
4137
.. _pairwise: /examples/analysis/alignment_and_rms/pairwise_rmsd.ipynb
42-
.. _rmsf: /examples/analysis/alignment_and_rms/rmsf.ipynb
38+
.. _align_structure: aligning_structure_to_another.ipynb
39+
.. _align_trajectory: aligning_trajectory.ipynb
40+
.. _align_trajectory_frame: aligning_trajectory_to_frame.ipynb

2.9.0-dev0/_sources/examples/analysis/alignment_and_rms/rmsd.ipynb.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@
289289
"source": [
290290
"### Plotting the data\n",
291291
"\n",
292-
"We can easily plot this data using the common data analysis package [pandas](https://pandas.pydata.org). We turn the ``R.rmsd`` array into a [DataFrame](https://pandas.pydata.org/pandas-docs/stable/getting_started/dsintro.html#dataframe) and label each column below."
292+
"We can easily plot this data using the common data analysis package [pandas](https://pandas.pydata.org). We turn the ``R.rmsd`` array into a [DataFrame](https://pandas.pydata.org/docs/user_guide/dsintro.html#dataframe) and label each column below."
293293
]
294294
},
295295
{

2.9.0-dev0/_sources/formats/reference/gsd.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Reading in
1818

1919
A user will only get an error if the number of particles changes from the first time step. MDAnalysis does not currently check for changes in the particle identity or topology, and it does not update these over the trajectory.
2020

21-
.. _HOOMD-blue : http://codeblue.umich.edu/hoomd-blue/index.html
21+
.. _HOOMD-blue : https://glotzerlab.engin.umich.edu/hoomd-blue/
2222

2323
.. note:: **Residue resnames**
2424

2.9.0-dev0/_sources/formats/reference/mmtf.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ The Macromolecular Transmission Format format
1212

1313
Individual models within the MMTF file are available via the ``models`` attribute of Universe.
1414

15-
.. _MMTF: https://mmtf.rcsb.org/
15+
.. _MMTF: https://github.com/rcsb/mmtf

2.9.0-dev0/_sources/formats/reference/xml.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Hoomd XML does not identify molecules or residues, so placeholder values
1313
are used for residue numbers.
1414
Bonds and angles are read if present.
1515

16-
.. _HOOMD: http://codeblue.umich.edu/hoomd-blue/index.html
16+
.. _HOOMD: https://glotzerlab.engin.umich.edu/hoomd-blue/index.html
1717
.. _XML: http://codeblue.umich.edu/hoomd-blue/doc/page_xml_file_format.html
1818

1919
Hoomd XML format does not contain a node for names. The parser will

2.9.0-dev0/_sources/releases.md.txt

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# MDAnalysis Release Notes
2-
3-
1+
# MDAnalysis Release Notes
2+
3+
44
## Release 2.8.0 of MDAnalysis
55

66
This a minor release of MDAnalysis.
@@ -33,8 +33,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.8.0/
3333
* The `guess_bonds`, `vdwradii`, `fudge_factor`, and `lower_bound` kwargs are deprecated for bond guessing during Universe creation.
3434
Instead, pass `("bonds", "angles", "dihedrals")` into `to_guess` or `force_guess` during Universe creation, and the associated `vdwradii`, `fudge_factor`, and `lower_bound` kwargs into `Guesser` creation. Alternatively, if `vdwradii`, `fudge_factor`, and `lower_bound` are passed into `Universe.guess_TopologyAttrs`, they will override the previous values of those kwargs.
3535
* MDAnalysis.topology.guessers and MDAnalysis.topology.tables are deprecated in favour of the new Guessers API and will be removed in MDAnalysis v3.0.
36-
* Unknown masses are set to 0.0 for current version, this will be depracated in MDAnalysis v3.0.0 and replaced by :class:`Masses`' no_value_label attribute (np.nan).
37-
36+
* Unknown masses are set to 0.0 for current version, this will be depracated in MDAnalysis v3.0.0 and replaced by :class:`Masses`' no_value_label attribute (np.nan).
37+
3838
## Release 2.7.0 of MDAnalysis
3939

4040
This a minor release of MDAnalysis.
@@ -85,8 +85,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.7.0/
8585
* [@Sumit112192](https://github.com/Sumit112192) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4346
8686
* [@HeetVekariya](https://github.com/HeetVekariya) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4359
8787
* [@JoStoe](https://github.com/JoStoe) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4292
88-
* [@ljwoods2](https://github.com/ljwoods2) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4366
89-
88+
* [@ljwoods2](https://github.com/ljwoods2) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4366
89+
9090
## Release 2.6.1 of MDAnalysis
9191

9292
This is a bugfix release of the 2.6.x version branch of MDAnalysis, it serves as an amendment to the earlier released version 2.6.0.
@@ -102,8 +102,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.6.1/
102102
* Clarification of SurvivalProbability function documentation [Issue #4247, PR #4248]1
103103

104104
### New Contributors
105-
* [@pillose](https://github.com/pillose) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4168
106-
105+
* [@pillose](https://github.com/pillose) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4168
106+
107107
## Release 2.6.0 of MDAnalysis
108108

109109
This a minor release of MDAnalysis.
@@ -139,13 +139,13 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.6.0/
139139

140140
#### Deprecations:
141141
* The misspelt `Boltzman_constant` entry in `MDAnalysis.units` is now deprecated in favour the correctly spelt `Boltzmann_constant`. (https://github.com/MDAnalysis/mdanalysis/pull/4230 and https://github.com/MDAnalysis/mdanalysis/pull/4214)
142-
* `MDAnalysis.analysis.hole2` is now deprecated in favour of a new [HOLE2 MDAKit](https://www.mdanalysis.org/hole2-mdakit/). (https://github.com/MDAnalysis/mdanalysis/pull/4200)
142+
* `MDAnalysis.analysis.hole2` is now deprecated in favour of a new [HOLE2 MDAKit](https://mdakits.mdanalysis.org/mdahole2.html). (https://github.com/MDAnalysis/mdanalysis/pull/4200)
143143

144144
### New Contributors
145145
* [@MohitKumar020291](https://github.com/MohitKumar020291) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4182
146146
* [@Shubx10](https://github.com/Shubx10) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4184
147-
* [@ztimol](https://github.com/ztimol) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4191
148-
147+
* [@ztimol](https://github.com/ztimol) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4191
148+
149149
## Release 2.5.0 of MDAnalysis
150150

151151
This a minor release of MDAnalysis.
@@ -253,25 +253,25 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.5.0/
253253
* [@SophiaRuan](https://github.com/SophiaRuan) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4072
254254
* [@marinegor](https://github.com/marinegor) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4085
255255
* [@g2707](https://github.com/g2707) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4089
256-
* [@DanielJamesEvans](https://github.com/DanielJamesEvans) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4109
257-
256+
* [@DanielJamesEvans](https://github.com/DanielJamesEvans) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/4109
257+
258258
## Release 2.4.3 of MDAnalysis
259259

260260
This is a bugfix release of the 2.4.x version of MDAnalysis, it serves as an amendment to the earlier released version 2.4.2.
261261

262262
### Bug fixes
263263
* Fixed DCD reading for large (>2Gb) files (Issue #4039). This was broken for versions 2.4.0, 2.4.1 and 2.4.2.
264-
* Fix element parsing from PSF files tests read via Parmed (Issue #4015)
265-
264+
* Fix element parsing from PSF files tests read via Parmed (Issue #4015)
265+
266266
## Release 2.4.2 of MDAnalysis
267267

268268
This is a bugfix release of the 2.4.x version of MDAnalysis, it serves as an amendment to the earlier released version 2.4.1.
269269

270270
### Bug fixes
271271

272272
* Fixed an issue where the arguments passed to np.histogramdd in `MDAnalysis.analysis.DensityAnalysis` were not compatible with the 1.24 release of NumPy (PR #3976)
273-
* Fixed upcoming incompatibilities with NumPy 1.25 in `MDAnalysis.visualization.streamlines_3D` and `MDAnalysis.visualization.streamlines` where incorrect comparison of the truth of arrays would have led to failures (PR #3977)
274-
273+
* Fixed upcoming incompatibilities with NumPy 1.25 in `MDAnalysis.visualization.streamlines_3D` and `MDAnalysis.visualization.streamlines` where incorrect comparison of the truth of arrays would have led to failures (PR #3977)
274+
275275
## Release 2.4.1 of MDAnalysis
276276

277277
This is a bugfix release of the 2.4.x version of MDAnalysis, it serves as an amendment to the earlier released version 2.4.0.
@@ -280,8 +280,8 @@ This is a bugfix release of the 2.4.x version of MDAnalysis, it serves as an ame
280280

281281
* The minimum version of biopython has been raised to 1.80 for pip installs
282282
* pytng has been added as an optional dependency
283-
284-
283+
284+
285285
## Release 2.4.0 of MDAnalysis
286286

287287
This a minor release of MDAnalysis, as per our once-every-three-months schedule.
@@ -325,8 +325,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.4.0/
325325
* [@jfennick](https://github.com/jfennick) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/3832
326326
* [@Hakarishirenai](https://github.com/Hakarishirenai) made their first contribution in https://github.com/MDAnalysis/mdanalysis/pull/3956
327327

328-
329-
328+
329+
330330
## Release 2.3.0 of MDAnalysis
331331

332332
This a minor release of MDAnalysis, as per our once-every-three-months schedule.
@@ -366,8 +366,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.3.0/
366366
A series of performance improvements to the MDAnalysis library's backend have been made as per planned work under MDAnalysis' CZI EOSS4 grant. Further details about these will be provided in a future blog post.
367367

368368
- `MDAnalysis.lib.distances` now accepts `AtomGroups` as well as NumPy arrays (PR #3730).
369-
- Timestep has been converted to a Cython Extension type (PR #3683).
370-
369+
- Timestep has been converted to a Cython Extension type (PR #3683).
370+
371371
## Release 2.2.0 of MDAnalysis
372372

373373
In line with NEP29, this version of MDAnalysis drops support for Python 3.7 and raises the minimum NumPy version to 1.19.0. Minimum version support has also been changed for the following packages; `networkx>=2.0`, `scipy>=1.5.0`, `gsd>=1.9.3`. Further details on MDAnalysis future support strategy and NEP29 will be released shortly.
@@ -425,8 +425,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.2.0/
425425

426426
### Known test failures:
427427
- Windows builds
428-
* In some cases users may get permission errors with tests involving symlinks. This should not impact the behaviour of MDAnalysis but may impact the creation of temporary files when using HOLE2 (see: https://github.com/MDAnalysis/mdanalysis/issues/3556).
429-
428+
* In some cases users may get permission errors with tests involving symlinks. This should not impact the behaviour of MDAnalysis but may impact the creation of temporary files when using HOLE2 (see: https://github.com/MDAnalysis/mdanalysis/issues/3556).
429+
430430
## Release 2.1.0 of MDAnalysis
431431

432432
In line with ongoing attempts to align with NEP29, this version of MDAnalysis drops support for Python 3.6 and raises the minimum NumPy version to 1.18.0.
@@ -467,8 +467,8 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.1.0/
467467
- `pytest-xdist` and more than 4 workers
468468
* Under these conditions a test related to logging for HydrogenBondAnalysis can fail. This is not thought to impact the validity of MDAnalysis. See here for more details: https://github.com/MDAnalysis/mdanalysis/issues/3543
469469
- Windows builds
470-
* In some cases users may get permission errors with tests involving symlinks. This should not impact the behaviour of MDAnalysis but may impact the creation of temporary files when using HOLE2 (see: https://github.com/MDAnalysis/mdanalysis/issues/3556).
471-
470+
* In some cases users may get permission errors with tests involving symlinks. This should not impact the behaviour of MDAnalysis but may impact the creation of temporary files when using HOLE2 (see: https://github.com/MDAnalysis/mdanalysis/issues/3556).
471+
472472
## Release 2.0.0 of MDAnalysis
473473

474474
This is the first version of MDAnalysis to solely support python 3.6+
@@ -534,5 +534,5 @@ See the [CHANGELOG](https://github.com/MDAnalysis/mdanalysis/blob/release-2.0.0/
534534

535535
### Known issues:
536536
- Windows builds
537-
* For some compilers (seen on MVC v.19xx), differences in floating point precision leads to PBC wrapping differing from expected outcomes. This leads to failures in the `MDAnalysisTests.lib.test_augment` tests. To our knowledge this does not significantly affect results (as all other tests pass). We will aim to fix this in version 2.1.0.
538-
537+
* For some compilers (seen on MVC v.19xx), differences in floating point precision leads to PBC wrapping differing from expected outcomes. This leads to failures in the `MDAnalysisTests.lib.test_augment` tests. To our knowledge this does not significantly affect results (as all other tests pass). We will aim to fix this in version 2.1.0.
538+

2.9.0-dev0/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ <h2>Where to start?<a class="headerlink" href="#where-to-start" title="Link to t
255255
<div><ul class="simple">
256256
<li><p>the <a class="reference external" href="http://help.github.com/">GitHub help pages</a>.</p></li>
257257
<li><p>the <a class="reference external" href="http://docs.scipy.org/doc/numpy/dev/index.html">NumPy’s documentation</a>.</p></li>
258-
<li><p>Matthew Brett’s <a class="reference external" href="http://matthew-brett.github.com/pydagogue/">Pydagogue</a>.</p></li>
258+
<li><p>Matthew Brett’s <a class="reference external" href="https://matthew-brett.github.io/pydagogue/">Pydagogue</a>.</p></li>
259259
</ul>
260260
</div></blockquote>
261261
<section id="getting-started-with-git">

2.9.0-dev0/examples/analysis/README.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,10 +275,10 @@ <h2>Imports and dependencies<a class="headerlink" href="#imports-and-dependencie
275275
<p>The <a class="reference external" href="https://docs.mdanalysis.org/2.9.0-dev0/documentation_pages/analysis/align.html#module-MDAnalysis.analysis.align" title="(in MDAnalysis v2.9.0-dev0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">MDAnalysis.analysis.align</span></code></a> and <a class="reference external" href="https://docs.mdanalysis.org/2.9.0-dev0/documentation_pages/analysis/rms.html#module-MDAnalysis.analysis.rms" title="(in MDAnalysis v2.9.0-dev0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">MDAnalysis.analysis.rms</span></code></a>
276276
modules contain the functions used for aligning structures,
277277
aligning trajectories, and calculating root mean squared quantities.</p>
278-
<p>Demonstrations of alignment are in <a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_structure_to_another.ipynb">align_structure</a>,
279-
<a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_trajectory_to_first_frame.ipynb">align_trajectory_first</a>, and <a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_trajectory.ipynb">align_trajectory</a>. Another example of
278+
<p>Demonstrations of alignment are in <a class="reference external" href="aligning_structure_to_another.ipynb">align_structure</a>,
279+
<a class="reference external" href="aligning_trajectory_to_frame.ipynb">align_trajectory_first</a>, and <a class="reference external" href="aligning_trajectory.ipynb">align_trajectory</a>. Another example of
280280
generating an average structure from an alignment is demonstrated in
281-
<a class="reference external" href="/examples/analysis/alignment_and_rms/rmsf.ipynb">rmsf</a>. Typically, trajectories need to be aligned for RMSD and
281+
<a class="reference external" href="rmsf.ipynb">rmsf</a>. Typically, trajectories need to be aligned for RMSD and
282282
RMSF values to make sense.</p>
283283
<div class="admonition note">
284284
<p class="admonition-title">Note</p>

2.9.0-dev0/examples/analysis/alignment_and_rms/README.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,10 @@
217217
<p>The <a class="reference external" href="https://docs.mdanalysis.org/2.9.0-dev0/documentation_pages/analysis/align.html#module-MDAnalysis.analysis.align" title="(in MDAnalysis v2.9.0-dev0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">MDAnalysis.analysis.align</span></code></a> and <a class="reference external" href="https://docs.mdanalysis.org/2.9.0-dev0/documentation_pages/analysis/rms.html#module-MDAnalysis.analysis.rms" title="(in MDAnalysis v2.9.0-dev0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">MDAnalysis.analysis.rms</span></code></a>
218218
modules contain the functions used for aligning structures,
219219
aligning trajectories, and calculating root mean squared quantities.</p>
220-
<p>Demonstrations of alignment are in <a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_structure_to_another.ipynb">align_structure</a>,
221-
<a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_trajectory_to_first_frame.ipynb">align_trajectory_first</a>, and <a class="reference external" href="/examples/analysis/alignment_and_rms/aligning_trajectory.ipynb">align_trajectory</a>. Another example of
220+
<p>Demonstrations of alignment are in <a class="reference internal" href="aligning_structure_to_another.html"><span class="doc">align_structure</span></a>,
221+
<a class="reference internal" href="aligning_trajectory_to_frame.html"><span class="doc">align_trajectory_first</span></a>, and <a class="reference internal" href="aligning_trajectory.html"><span class="doc">align_trajectory</span></a>. Another example of
222222
generating an average structure from an alignment is demonstrated in
223-
<a class="reference external" href="/examples/analysis/alignment_and_rms/rmsf.ipynb">rmsf</a>. Typically, trajectories need to be aligned for RMSD and
223+
<a class="reference internal" href="rmsf.html"><span class="doc">rmsf</span></a>. Typically, trajectories need to be aligned for RMSD and
224224
RMSF values to make sense.</p>
225225
<div class="admonition note">
226226
<p class="admonition-title">Note</p>

0 commit comments

Comments
 (0)