Skip to content

Commit 9784b3b

Browse files
namirouesmicaela-mattaRMeli
authored
update citations page (#456)
* update citations page * Update pages/citations.md Co-authored-by: Rocco Meli <[email protected]> * address PR comments * address PR review comment --------- Co-authored-by: Micaela Matta <[email protected]> Co-authored-by: Rocco Meli <[email protected]>
1 parent 8ee8398 commit 9784b3b

File tree

1 file changed

+10
-27
lines changed

1 file changed

+10
-27
lines changed

pages/citations.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,9 @@ manager formats) contains the citations associated with the specific
1515
algorithms and libraries that were used in the program.
1616

1717

18-
1918
## MDAnalysis library ##
2019

21-
When using MDAnalysis in published work, please cite the following two
22-
papers.
23-
24-
(We are asking you to cite *both* papers if at all possible because
25-
the 2016 paper describes many updates to the original 2011 paper and
26-
neither paper on its own provides a comprehensive description of the
27-
library. We will publish a complete self-contained paper with the
28-
upcoming 1.0 release of MDAnalysis, which will then supersede these
29-
two citations.)
20+
To properly credit MDAnalysis, please cite both of the following papers. The 2016 paper details significant updates to the 2011 paper, and together they provide a comprehensive description of the library.
3021

3122
* <a name="Gowers2016"></a>R. J. Gowers, M. Linke, J. Barnoud, T. J. E. Reddy,
3223
M. N. Melo, S. L. Seyler, D. L. Dotson, J. Domanski, S. Buchoux,
@@ -53,7 +44,7 @@ two citations.)
5344
## Powered by MDAnalysis
5445
[![Powered by MDAnalysis](https://img.shields.io/badge/powered%20by-MDAnalysis-orange.svg?logoWidth=16&logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIAAoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJD+XwCY/fEAkf3uAJf97wGT/a+HfHaoiIWE7n9/f+6Hh4fvgICAjwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACT/yYAlP//AJ///wCg//8JjvOchXly1oaGhv+Ghob/j4+P/39/f3IAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJH8aQCY/8wAkv2kfY+elJ6al/yVlZX7iIiI8H9/f7h/f38UAAAAAAAAAAAAAAAAAAAAAAAAAAB/f38egYF/noqAebF8gYaagnx3oFpUUtZpaWr/WFhY8zo6OmT///8BAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgICAn46Ojv+Hh4b/jouJ/4iGhfcAAADnAAAA/wAAAP8AAADIAAAAAwCj/zIAnf2VAJD/PAAAAAAAAAAAAAAAAICAgNGHh4f/gICA/4SEhP+Xl5f/AwMD/wAAAP8AAAD/AAAA/wAAAB8Aov9/ALr//wCS/Z0AAAAAAAAAAAAAAACBgYGOjo6O/4mJif+Pj4//iYmJ/wAAAOAAAAD+AAAA/wAAAP8AAABhAP7+FgCi/38Axf4fAAAAAAAAAAAAAAAAiIiID4GBgYKCgoKogoB+fYSEgZhgYGDZXl5e/m9vb/9ISEjpEBAQxw8AAFQAAAAAAAAANQAAADcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAjo6Mb5iYmP+cnJz/jY2N95CQkO4pKSn/AAAA7gAAAP0AAAD7AAAAhgAAAAEAAAAAAAAAAACL/gsAkv2uAJX/QQAAAAB9fX3egoKC/4CAgP+NjY3/c3Nz+wAAAP8AAAD/AAAA/wAAAPUAAAAcAAAAAAAAAAAAnP4NAJL9rgCR/0YAAAAAfX19w4ODg/98fHz/i4uL/4qKivwAAAD/AAAA/wAAAP8AAAD1AAAAGwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALGxsVyqqqr/mpqa/6mpqf9KSUn/AAAA5QAAAPkAAAD5AAAAhQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADkUFBSuZ2dn/3V1df8uLi7bAAAATgBGfyQAAAA2AAAAMwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0AAADoAAAA/wAAAP8AAAD/AAAAWgC3/2AAnv3eAJ/+dgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA9AAAA/wAAAP8AAAD/AAAA/wAKDzEAnP3WAKn//wCS/OgAf/8MAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIQAAANwAAADtAAAA7QAAAMAAABUMAJn9gwCe/e0Aj/2LAP//AQAAAAAAAAAA)](https://www.mdanalysis.org)
5546

56-
We appreciate it if you display our badge in your projects that use MDAnalysis. You can use the embed code below that suits your markup:
47+
If you use MDAnalysis in your projects, **we encourage you to display our badge**. You can use the embed code below that suits your markup:
5748

5849
<details>
5950
<summary>Markdown</summary>
@@ -87,22 +78,14 @@ We appreciate it if you display our badge in your projects that use MDAnalysis.
8778

8879
## <a name="IncludedAlgorithms"></a>Included algorithms ##
8980

90-
The full list of [references for included
91-
algorithms]({{site.pypi.docs}}/documentation_pages/references.html#citations-for-included-algorithms-and-modules)
92-
is maintained and kept up-to-date as part of the documentation.
81+
The full list of citations for [included algorithms]({{site.pypi.docs}}/documentation_pages/references.html#citations-for-included-algorithms-and-modules) is maintained in our documentation and updated regularly.
9382

9483
## Acknowledgements
9584

96-
MDAnalysis was originally inspired by the Schulten Group's
97-
[MDTools](http://www.ks.uiuc.edu/Development/MDTools/) for Python, and the DCD
98-
reading code is derived from VMD's
99-
[catdcd](http://www.ks.uiuc.edu/Development/MDTools/catdcd/). MDAnalysis is GPL
100-
licensed, except for some 3rd party code that is included under GPL-compatible
101-
licenses; for instance the dcd reading code is under the [UIUC Open Source
102-
Licence](http://www.ks.uiuc.edu/Development/MDTools/catdcd/license.html). See
103-
the files AUTHORS and LICENSE in the distribution for details.
104-
105-
The **MDAnalysis 'Atom' Logo** was designed by [**Christian
106-
Beckstein**](https://www.linkedin.com/in/beckstein/) and is licensed
107-
under a [Creative Commons Attribution-NoDerivs 3.0 Unported
108-
License](http://creativecommons.org/licenses/by-nd/3.0/).
85+
MDAnalysis was inspired by the Schulten Group’s [MDTools](http://www.ks.uiuc.edu/Development/MDTools/) for Python.
86+
87+
The DCD reading code originates from VMD’s [catdcd](http://www.ks.uiuc.edu/Development/MDTools/catdcd/).
88+
89+
MDAnalysis is released under the [LGPL](https://www.gnu.org/licenses/lgpl-3.0.html) license, with some third-party code under LGPL-compatible licenses. For instance, the DCD reading code is licensed under the [UIUC Open Source Licence](http://www.ks.uiuc.edu/Development/MDTools/catdcd/license.html). See the files [AUTHORS](https://github.com/MDAnalysis/mdanalysis/blob/develop/package/AUTHORS) and [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/package/LICENSE) in the distribution for details.
90+
91+
The **MDAnalysis 'Atom' Logo** was designed by [Christian Beckstein](https://www.linkedin.com/in/beckstein/). NumFOCUS as the fiscal sponsor of MDAnalysis holds all rights on the logo (see [branding/logos/LICENSE](https://github.com/MDAnalysis/branding/blob/main/logos/LICENSE)).

0 commit comments

Comments
 (0)