https://github.com/mdanalysis/userguide
User Guide for MDAnalysis
https://github.com/mdanalysis/userguide
Last synced: 11 months ago
JSON representation
User Guide for MDAnalysis
- Host: GitHub
- URL: https://github.com/mdanalysis/userguide
- Owner: MDAnalysis
- Created: 2019-08-14T13:32:11.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-29T03:16:43.000Z (over 1 year ago)
- Last Synced: 2024-10-29T17:39:45.746Z (over 1 year ago)
- Language: Python
- Homepage: https://userguide.mdanalysis.org
- Size: 557 MB
- Stars: 22
- Watchers: 12
- Forks: 34
- Open Issues: 67
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
================================
MDAnalysis User Guide
================================
|build| |binder|
|usergroup| |developergroup|
MDAnalysis is a Python toolkit to analyse molecular dynamics files and trajectories in `many popular formats`_. MDAnalysis can write most of these formats, too, together with atom selections for use in visualisation tools or other analysis programs. It provides a fast framework for complex analysis tasks, as well as flexible tooling to construct your own analyses.
This repository contains the `user guide`_ for MDAnalysis. The user guide originated as a `project for Google Season of Docs 2019-2020`_.
The code in the user guide is released under the `GNU LGPL v2.1+` license, while text and images are released under the `CC BY-SA 4.0 DEED`_ license.
.. Footnotes
.. _`CC BY-SA 4.0 DEED`: https://creativecommons.org/licenses/by-sa/4.0/
.. _`GNU LGPL v2.1+`: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
.. _`user guide`: https://www.mdanalysis.org/UserGuide/index.html
.. _`many popular formats`: https://www.mdanalysis.org/UserGuide/formats/index.html
.. _MDAnalysis: https://www.mdanalysis.org
.. _LICENSE: https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE
.. _`project for Google Season of Docs 2019-2020`: https://developers.google.com/season-of-docs/docs/2019/participants/project-mdanalysis
.. |usergroup| image:: https://img.shields.io/badge/Google%20Group-Users-lightgrey.svg
:alt: User Google Group
:target: http://users.mdanalysis.org
.. |developergroup| image:: https://img.shields.io/badge/Google%20Group-Developers-lightgrey.svg
:alt: Developer Google Group
:target: http://developers.mdanalysis.org
.. |build| image:: https://github.com/MDAnalysis/UserGuide/actions/workflows/gh-ci.yaml/badge.svg
:alt: Build Status
:target: https://github.com/MDAnalysis/UserGuide/actions/workflows/gh-ci.yaml
.. |binder| image:: https://mybinder.org/badge_logo.svg
:alt: Binder
:target: https://mybinder.org/v2/gh/MDAnalysis/binder-env-userguide/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FMDAnalysis%252FUserGuide%26urlpath%3Dtree%252FUserGuide%252Fdoc%252Fsource%252Fexamples%26branch%3Dmaster