Skip to content

Commit 30bdb38

Browse files
authored
Sdg23 refine 'learning MDAnalysis' page (#444)
* refine 'learning MDAnalysis' page * address PR review comments * address PR review comments and restructure page
1 parent 186f626 commit 30bdb38

1 file changed

Lines changed: 23 additions & 52 deletions

File tree

pages/learning_MDAnalysis.md

Lines changed: 23 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,39 @@ title: Learning MDAnalysis
44
order: 3
55
---
66

7-
Once you had a look at the
8-
[basic example]({{ site.baseurl }}/pages/basic_example)
9-
you might want to learn more about how to use
10-
MDAnalysis. MDAnalysis is primarily a library that helps you to build
11-
your own tools but it also works very well for **interactive data
12-
exploration** of MD data in [IPython](http://ipython.org/), in
13-
particular within [Jupyter notebooks](https://jupyter.org/) and in
14-
conjunction with [pandas](http://pandas.pydata.org/). MDAnalysis is
15-
well suited for a *rapid development* approach.
7+
MDAnalysis is a powerful Python library for analyzing MD simulations. While primarily designed to help you build custom analysis tools, it also supports interactive data exploration in environments like [IPython](http://ipython.org/) and [Jupyter notebooks](https://jupyter.org/), especially when combined with [pandas](http://pandas.pydata.org/). This makes MDAnalysis an excellent choice for rapid prototyping and exploratory analysis.
168

17-
The resources below should help you to quickly find out to best use
18-
MDAnalysis for your own specific uses.
9+
MDAnalysis is an academic software package, and if you use it in your research, please cite the relevant publications. For details on how to cite MDAnalysis, visit our [Citations]({{ site.baseurl }}/pages/citations/) page.
1910

11+
Whether you're new to MDAnalysis or looking to deepen your expertise, this page will guide you through our learning resources.
2012

21-
## Tutorials ##
13+
## Step-by-Step Guide to Learning MDAnalysis
2214

23-
Start with the [{{ site.docs.quickstart.name }}]({{
24-
site.docs.quickstart.url }}) when you are new MDAnalysis.
15+
1. **Install MDAnalysis**
16+
Follow the instructions in [Getting Started]({{ site.baseurl }}/pages/getting_started/) to install MDAnalysis.
2517

26-
Then browse the [{{ site.docs.userguide.name }}]({{ site.docs.userguide.url }}), which contains detailed documentation for all the important parts of MDAnalysis and many self-contained tutorials.
18+
2. **Quickstart Tutorial**
19+
Begin with the [{{ site.docs.quickstart.name }}]({{ site.docs.quickstart.url }}) tutorial to write and run your first MDAnalysis script.
2720

21+
3. **User Guide**
22+
Explore the [{{ site.docs.userguide.name }}]({{ site.docs.userguide.url }}) for detailed tutorials and self-contained examples.
2823

29-
There are a number of [older tutorials]({{site.github.wiki}}/Tutorials) available, too, although we recommend new users start with [{{ site.docs.quickstart.name }}]({{
30-
site.docs.quickstart.url }}) and then start reading the [{{ site.docs.userguide.name }}]({{ site.docs.userguide.url }}).
24+
4. **Tutorials Repository**
25+
Browse additional learning resources and code examples in our Tutorials repository.
3126

27+
5. **Full Documentation**
28+
For in-depth technical details, visit the [Documentation]({{ site.baseurl }}/pages/documentation/) page.
3229

33-
## Documentation ##
30+
6. **Watch MDAnalysis videos**
31+
Learn from conference talks, workshops, and webinars presented by core developers. Explore the [Videos](#videos) section below and our [YouTube channel](https://www.youtube.com/channel/UC3TCuK-z_bJNdwWCvsH9D3Q).
32+
33+
If you need help, check out our [Community]({{ site.baseurl }}/pages/community/) page.
3434

35-
The [{{ site.docs.userguide.name }}]({{ site.docs.userguide.url }})
36-
contains installation instructions, the [{{ site.docs.quickstart.name
37-
}}]({{ site.docs.quickstart.url }}), and comprehensive description of
38-
the functionality of MDAnalysis from a user's perspective. **New users
39-
should start here!**
35+
## Videos
4036

41-
The [{{ site.docs.mdanalysis.name }}]({{ site.docs.mdanalysis.url }})
42-
contains technical information on how to use MDAnalysis.
37+
The following videos, presented by core developers at conferences, highlight various aspects of MDAnalysis and demonstrate its use in research.
4338

44-
The [paper on MDAnalysis]({{ site.baseurl
45-
}}/pages/citations#Gowers2016) contains a high-level description of
46-
the structure and philosophy of the library together with examples of
47-
its use.
48-
49-
The [FAQ]({{ site.github.wiki }}/FAQ) contains a
50-
growing list of specific (frequently asked) questions and answers.
51-
52-
## GitHub Discussions ##
53-
54-
You can ask for advice or help on [{{ site.mailinglists.discussion.name }}]({{
55-
site.mailinglists.discussion.url }}). If you find *bugs* or
56-
want to *request enhancements* please [file a report]({{
57-
site.github.wiki }}/ReportingProblems) in the [Issue Tracker]({{
58-
sitemap.github.issues }}).
59-
60-
## Videos ##
61-
62-
The videos listed below were given by core developers at
63-
conferences. They highlight various aspects of MDAnalysis and show how
64-
to use it in a research context.
65-
66-
### Introductory ###
39+
### Introductory
6740

6841
#### The universe as balls and springs: molecular dynamics in Python
6942
@lilyminium's talk at [PyCon AU 2019](https://2019.pycon-au.org/) *The universe as balls and
@@ -95,9 +68,7 @@ analysis of molecular dynamics
9568
simulations](http://conference.scipy.org/proceedings/scipy2016/oliver_beckstein.html)
9669
which adds detail to the concepts outlined in this talk.
9770

98-
99-
100-
### Intermediate ###
71+
### Intermediate
10172

10273
#### Looking at molecules using Python
10374
@jbarnoud presented at the PyGrunn 2017 conference _Looking at
@@ -112,7 +83,6 @@ data):
11283
allowfullscreen class="video"></iframe>
11384
</div>
11485

115-
11686
#### BioExcel Webinar: MDAnalysis: Interoperable analysis of biomolecular simulations in Python
11787

11888
In this [BioExcel](https://bioexcel.eu/) webinar, three of the MDAnalysis Core
@@ -125,3 +95,4 @@ MDAnalysis**, show more advanced ways to **hack MDAnalysis** and outline
12595
allowfullscreen class="video"></iframe>
12696
</div>
12797

98+

0 commit comments

Comments
 (0)