Skip to content

Commit 9b4b76f

Browse files
authored
update landing page (#455)
* update landing page * add badge info in the citations section * address PR review comments * address PR review comments
1 parent 51d8bca commit 9b4b76f

File tree

1 file changed

+52
-77
lines changed

1 file changed

+52
-77
lines changed

index.md

Lines changed: 52 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -7,93 +7,68 @@ title: MDAnalysis
77
<img src="{{ site.baseurl }}/public/mdanalysis-logo_square.png"
88
style="float: right" alt="MDAnalysis" width="30%"/>
99

10-
**MDAnalysis** is an object-oriented Python library to analyze
11-
trajectories from molecular dynamics (MD) simulations in [many popular
12-
formats]({{site.pypi.docs}}/documentation_pages/coordinates/init.html#id1). It
13-
can write most of these formats, too, together with [atom
14-
selections]({{site.pypi.docs}}/documentation_pages/selections_modules.html#selection-exporters)
15-
suitable for visualization or native analysis tools.
16-
17-
MDAnalysis allows one to read particle-based trajectories (including
18-
individual coordinate frames such as biomolecules in the PDB format)
19-
and access the atomic coordinates through
20-
[NumPy](https://numpy.org/) arrays. This provides a flexible and
21-
relatively fast framework for complex analysis tasks. In addition,
22-
powerful atom
23-
[selection commands]({{site.pypi.docs}}/documentation_pages/selections.html)
24-
are implemented. Trajectories can also be manipulated (for instance,
25-
fit to a reference structure) and written out. The
26-
[basic example]({{ site.baseurl }}/pages/basic_example) demonstrates some
27-
of these features.
28-
29-
Read more:
30-
31-
* [installation quick start]({{ site.baseurl }}/pages/installation_quick_start)
32-
* [learning MDAnalysis]({{ site.baseurl }}/pages/learning_MDAnalysis)
33-
34-
Also, check out the [blog]({{ site.baseurl }}/blog) or subscribe to our
35-
[news feed]({{ site.baseurl }}/{{site.feed.path}}) to follow development
36-
updates and events.
37-
38-
## Availability ##
39-
40-
MDAnalysis can be [**easily
41-
installed**]({{site.baseurl}}/pages/installation_quick_start/) with
42-
its dependencies using the ``pip`` or ``conda`` package managers;
43-
MDAnalysis is also available in some recent Linux distributions.
44-
45-
All **source code** is available under the
46-
[GNU General Public License, version 2](https://www.gnu.org/licenses/gpl-2.0.html)
47-
(or any later version at your choice) from
48-
[github.com/MDAnalysis/mdanalysis](https://github.com/MDAnalysis/mdanalysis)
49-
and the Python Package index
50-
[pypi.org/project/MDAnalysis](https://pypi.org/project/MDAnalysis).
51-
52-
## Participating ##
53-
54-
Ask **questions** on the [{{ site.mailinglists.discussion.name }}
55-
forum]({{ site.mailinglists.discussion.url }}) and **be part of the
56-
conversation**. You can also join the [{{ site.discord.name }}
57-
Discord Server]({{ site.discord.url }}) to talk with other users and
58-
developers. (In order to join our Discord server, use the invitation link
59-
[{{ site.discord.invite }}]({{ site.discord.invite }}).)
60-
61-
Please report **bugs** or **enhancement requests** through the [Issue
62-
Tracker]({{ site.github.issues }}).
63-
64-
MDAnalysis is **open source** and welcomes *your* contributions. [Fork
65-
the repository on
66-
GitHub](https://github.com/MDAnalysis/mdanalysis#fork-destination-box)
67-
and submit a pull request. Participate on the [{{
68-
site.mailinglists.developer.name }}
69-
forum]({{ site.mailinglists.developer.url }}).
70-
71-
MDAnalysis regularly takes part in various **mentoring and outreach programs**, such as [Google Summer of Code](https://summerofcode.withgoogle.com/), [Google Season of Docs](https://developers.google.com/season-of-docs), [Outreachy](https://www.outreachy.org/), the [Station1 Frontiers Fellowship](https://www.station1.org/sff), and the [CompChemURG](https://www.bindingsites.co.uk/home) mentorship schemes. Many of the [current core developers](/about/#mdanalysis-core-developers/) joined the project through these mentoring schemes. The project also frequently offers **teaching workshops**, both online and in-person; recordings are often made available on the [MDAnalysis YouTube channel](https://www.youtube.com/@mdanalysis3040). Follow our [blog]({{ site.baseurl }}/blog), [LinkedIn](https://www.linkedin.com/company/mdanalysis/), [Twitter](https://twitter.com/mdanalysis), and [Bluesky](https://bsky.app/profile/mdanalysis.bsky.social) pages for updates on how to participate.
72-
73-
74-
## Supporting ##
75-
76-
If you like MDAnalysis and want to support our mission, please
77-
consider making a donation to support our efforts.
10+
The **MDAnalysis Project** develops open-source tools for the analysis of molecular simulation data, providing researchers with efficient and accessible solutions for studying molecular structures and dynamics.
7811

79-
{{ site.numfocus.donate_button }}
12+
MDAnalysis is a fiscally sponsored project of [NumFOCUS][], a nonprofit that promotes open practices in research, data, and scientific computing.
13+
14+
At the core of the project is *MDAnalysis*, **an open-source Python library** for analyzing molecular dynamics (MD) trajectories across [multiple formats]({{ site.docs.userguide.url }}/formats/index.html#formats). *MDAnalysis* enables seamless reading and writing of simulation data, allowing users to efficiently analyze molecular structures and dynamics, including particle-based trajectories and individual coordinate frames (e.g., biomolecules in the [PDB format][]).
15+
16+
With *MDAnalysis*, you can access atomic coordinates as [NumPy][] arrays, providing a flexible and efficient framework for complex analysis tasks. The library includes powerful [atom selection commands]({{ site.docs.userguide.url }}/selections.html) for extracting subsets of structures and supports trajectory transformations (e.g., fitting to a reference structure).
17+
18+
Learn more about our **mission, development, team, and governance** on the [About MDAnalysis]({{ site.baseurl }}/about/) page.
19+
20+
## Get Started
21+
22+
If you're new to *MDAnalysis*, explore the following resources to install the `MDAnalysis` package, access tutorials, and dive into the documentation:
23+
24+
- [Getting Started]({{ site.baseurl }}/pages/getting_started/)
25+
- [Learning MDAnalysis]({{ site.baseurl }}/pages/learning_MDAnalysis)
26+
- [Documentation]({{ site.baseurl }}/pages/documentation)
27+
28+
## Community
29+
30+
MDAnalysis is driven by an active **community of users and contributors**. Stay updated and get involved through the following pages:
31+
32+
<!-- TODO: Add link [Get Involved]({{ site.baseurl }}/pages/about/#get-involved)
33+
-->
34+
- [Community]({{ site.baseurl }}/pages/community/) &mdash; Get involved, ask questions, and collaborate.
35+
- [Blog]({{ site.baseurl }}/blog) &mdash; Stay updated with development news and community highlights.
36+
- [Events]({{ site.baseurl }}/pages/events/) &mdash; Join workshops, conferences, and mentoring programs.
37+
38+
## Contributing
39+
40+
Want to contribute to MDAnalysis? Here’s how:
8041

81-
(Donations are made through [our fiscal sponsor][], [NumFOCUS][], which is
82-
a 501(c)(3) non-profit charity in the United States; as such,
83-
donations to NumFOCUS are tax-deductible as allowed by law. As with
84-
any donation, you should consult with your personal tax adviser or the
85-
IRS about your particular tax situation.)
42+
- [Contribute]({{ site.baseurl }}/pages/contribute/) &mdash; Learn how to help improve MDAnalysis through coding, documentation, or discussions.
43+
- [MDAKits and MDA-based tools]({{ site.baseurl }}/pages/mdakits/) &mdash; Build and extend MDAnalysis with MDAKits.
44+
- [Support MDAnalysis financially](#funding--support) &mdash; Donate via NumFOCUS to sustain the project.
45+
46+
47+
## Citing MDAnalysis
48+
49+
If you use MDAnalysis in your research, please cite it appropriately and consider displaying our MDAnalysis badge in your projects. All citation formats and badge instructions are available in our [Citation guidelines]({{ site.baseurl }}/pages/citations/).
50+
51+
Additionally, consider displaying our badge in your projects that use MDAnalysis. We provide several [embedding markup examples]({{ site.baseurl }}/pages/citations/#powered-by-mdanalysis).
8652

8753
[![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)
88-
Additionally, consider displaying our badge in your projects that use
89-
MDAnalysis. We provide several [embedding markup examples]({{ site.baseurl }}/pages/citations/#powered-by-mdanalysis).
54+
55+
## Funding & Support
56+
57+
If you find MDAnalysis useful and would like to support its continued development, please consider making a donation. You can learn more about out Sponsors in our [Funding]({{ site.baseurl }}/pages/funding/) page.
58+
59+
{{ site.numfocus.donate_button }}
60+
61+
<small>
62+
Donations are made through [our fiscal sponsor][], [NumFOCUS][], which is a 501(c)(3) non-profit charity in the United States; as such, donations to NumFOCUS are tax-deductible as allowed by law. As with any donation, you should consult with your personal tax adviser or the IRS about your particular tax situation.
63+
</small>
9064

9165
<a href="https://github.com/MDAnalysis/mdanalysis"><img style="position: absolute; top:
9266
0; right: 0; border: 0;"
9367
src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67"
9468
alt="Fork me on GitHub"
9569
data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
9670

97-
9871
[NumFOCUS]: https://www.numfocus.org
9972
[our fiscal sponsor]: {{site.baseurl}}/about#partners
73+
[NumPy]: https://numpy.org/
74+
[PDB format]: https://www.wwpdb.org/documentation/file-format

0 commit comments

Comments
 (0)