@@ -22,20 +22,20 @@ most of these formats, too, together with atom selections for use in
2222Gromacs _, CHARMM _, VMD _ and PyMol _ (see :ref: `Selection exporters `).
2323
2424It allows one to read molecular dynamics trajectories and access the
25- atomic coordinates through NumPy _ arrays. This provides a flexible and
25+ atomic coordinates through ` NumPy `_ arrays. This provides a flexible and
2626relatively fast framework for complex analysis tasks. Fairly complete
2727atom :ref: `selection-commands-label ` are implemented. Trajectories can
2828also be manipulated (for instance, fit to a reference structure) and
2929written out in a range of formats.
3030
31- .. _ `www .mdanalysis.org` : https://www.mdanalysis.org
31+ .. _ www .mdanalysis.org : https://www.mdanalysis.org
3232.. _NumPy : https://numpy.org/
3333.. _CHARMM : http://www.charmm.org/
3434.. _Amber : http://ambermd.org/
3535.. _LAMMPS : http://lammps.sandia.gov/
3636.. _NAMD : http://www.ks.uiuc.edu/Research/namd/
3737.. _Gromacs : http://www.gromacs.org/
38- .. _ `DL_POLY` : http://www.scd.stfc.ac.uk//44516.aspx
38+ .. _ DL_POLY : http://www.scd.stfc.ac.uk//44516.aspx
3939.. _VMD : http://www.ks.uiuc.edu/Research/vmd/
4040.. _PyMol : http://www.pymol.org/
4141.. _PDB : http://www.rcsb.org/pdb/static.do?p=file_formats/pdb/index.html
@@ -48,37 +48,34 @@ Getting involved
4848Please report **bugs ** or **enhancement requests ** through the `Issue
4949Tracker `_. Questions can also be asked on the `GitHub Discussions `_.
5050
51- The MDAnalysis community subscribes to a `Code of Conduct `_ that all community
52- members agree and adhere to --- please read it.
51+ The MDAnalysis community follows a `Code of Conduct `_ that all members are expected to adhere to.
52+ Please take a moment to read it.
5353
5454.. _Issue Tracker : https://github.com/MDAnalysis/mdanalysis/issues
55- .. _`GitHub Discussions` :
56- https://github.com/MDAnalysis/mdanalysis/discussions
57- .. _`Code of Conduct` : https://www.mdanalysis.org/pages/conduct/
55+ .. _GitHub Discussions : https://github.com/MDAnalysis/mdanalysis/discussions
56+ .. _Code of Conduct : https://www.mdanalysis.org/pages/conduct/
5857
5958
59+ .. _installation-instructions :
6060
61- Installing and Using MDAnalysis
61+ Installing and using MDAnalysis
6262===============================
6363
64- The MDAnalysis `User Guide `_ provides comprehensive information on how to `install < https://userguide.mdanalysis.org/stable/installation.html > `_
64+ The MDAnalysis `User Guide `_ provides comprehensive information on how to `install `_
6565and use the library. We would recommend that new users have a look at the
6666`Quick Start Guide `_. The User Guide also has a set of `examples `_ on how to
6767use the MDAnalysis library which may be of interest.
6868
69- .. _ `User Guide` : https://userguide.mdanalysis.org/stable/index.html
70- .. _ `Quick Start Guide` : https://userguide.mdanalysis.org/stable/examples/quickstart.html
71- .. _ `examples` : https://userguide.mdanalysis.org/stable/examples/README.html
72-
69+ .. _ User Guide : https://userguide.mdanalysis.org/stable/index.html
70+ .. _ Quick Start Guide : https://userguide.mdanalysis.org/stable/examples/quickstart.html
71+ .. _ examples : https://userguide.mdanalysis.org/stable/examples/README.html
72+ .. _ install : https://userguide.mdanalysis.org/stable/installation.html
7373
74- .. _installation-instructions :
75-
76- Source Code
74+ Source code
7775===========
7876
79- **Source code ** is available from
80- https://github.com/MDAnalysis/mdanalysis/ and is packaged under the
81- `Lesser GNU Public Licence, version 3 or any later version `_. Individual components
77+ The MDAnalysis source code is available on [GitHub](https://github.com/MDAnalysis/mdanalysis/) and is
78+ distributed under the `Lesser GNU Public Licence, version 3 or any later version `_. Individual components
8279of the source code are provided under LGPL compatible licenses, details can be
8380found in the `MDAnalysis license file `_. Obtain the sources with `git `_.
8481
@@ -88,14 +85,12 @@ found in the `MDAnalysis license file`_. Obtain the sources with `git`_.
8885
8986
9087 The `User Guide `_ provides more information on how to
91- `install the development version `_ of MDAnalysis .
88+ `install from source `_ .
9289
93- .. _Lesser GNU Public Licence, version 3 or any later version :
94- https://www.gnu.org/licenses/lgpl-3.0.en.html
95- .. _MDAnalysis license file :
96- https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE
90+ .. _Lesser GNU Public Licence, version 3 or any later version : https://www.gnu.org/licenses/lgpl-3.0.en.html
91+ .. _MDAnalysis license file : https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE
9792.. _git : https://git-scm.com/
98- .. _ `install the development version` : https://userguide.mdanalysis.org/stable/installation.html#development-versions
93+ .. _ install from source : https://userguide.mdanalysis.org/stable/installation.html
9994
10095
10196Citation
@@ -104,14 +99,11 @@ Citation
10499When using MDAnalysis in published work, please cite
105100[Michaud-Agrawal2011 ]_ and [Gowers2016 ]_.
106101
107- MDAnalysis also contains specific algorithms and whole analysis
108- modules whose algorithms have also been published in the scientific
109- literature. Please make sure to also reference any
110- :ref: `references-components ` in published work.
102+ MDAnalysis includes specific algorithms and analysis modules, some of which have been published in the scientific literature.
103+ Please ensure you cite the relevant :ref: `references-components ` when using these features in your research.
111104
112105Thank you!
113106
114-
115107.. Hide the contents from the front page because they are already in
116108.. the side bar in the Alabaster sphinx style; requires Alabaster
117109.. config sidebar_includehidden=True (default)
0 commit comments