| layout | page | ||
|---|---|---|---|
| title | Documentation | ||
| order | 5 | ||
| redirect_from |
|
The [MDAnalysis library]({{ site.github.repo }}) (import MDAnalysis) is open-source code, available under the GNU Lesser General Public License, version 3 or later (LGPLv3+). MDAnalysis provides comprehensive documentation to help users at all levels—whether you're just getting started, developing new tools, or contributing to the project. From step-by-step tutorials to an in-depth API reference, these resources will guide you through installing, using, and extending MDAnalysis.
The MDAnalysis Project maintains many other software projects related to working with data in the molecular sciences, which can be found under the MDAnalysis GitHub organization.
The [User Guide]({{ site.docs.userguide.url }}) is the best place for new users to start. It includes:
- [Installation instructions]({{ site.docs.userguide.url }}/stable/installation.html)
- Tutorials and [examples]({{ site.docs.userguide.url }}/stable/examples/README.html)
- Detailed explanations of MDAnalysis functionalities (see for example the [
AtomGroup]({{ site.docs.userguide.url }}/stable/atomgroup.html))
The [API Reference]({{ site.docs.mdanalysis.url }}) offers detailed documentation on all MDAnalysis modules, classes, and functions—perfect for developers and advanced users.
Learn about the design philosophy and scientific impact of MDAnalysis in the [MDAnalysis paper]({{ site.baseurl }}/citations#Gowers2016).
If you need help or have ideas, visit our [Community]({{ site.baseurl }}/community) page to learn about available discussion channels.