Add initial docs for Unwrap transformation.

TODO: add video showing usage of Unwrap transformation
p-j-smith · Sep 16, 2023 · f0f5da5 · f0f5da5
1 parent d90d42f
commit f0f5da5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/transformations/index.md b/docs/transformations/index.md
@@ -5,3 +5,4 @@ There are currently three transformations available in MDAnalysis TUI:
 - [translate all atoms by a vector](translate.md), which uses [`MDAnalysis.transformations.translate.translate`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/translate.html#MDAnalysis.transformations.translate.translate)
 - [center atoms or molecule in a box](center-in-box.md), which uses [`MDAnalysis.transformations.translate.center_in_box`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/translate.html#MDAnalysis.transformations.translate.center_in_box)
 - [wrap atoms in a box](wrap.md), which uses [`MDAnalysis.transformations.wrap.wrap`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/wrap.html#MDAnalysis.transformations.wrap.wrap)
+- [unwrap atoms](unwrap.md), which uses [`MDAnalysis.transformations.wrap.unwrap`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/wrap.html#MDAnalysis.transformations.wrap.unwrap)
diff --git a/docs/transformations/unwrap.md b/docs/transformations/unwrap.md
@@ -0,0 +1,3 @@
+# Unwrap
+
+Unwrap an atom group so that its fragments are not split across periodic boundaries. Uses [`MDAnalysis.transformations.wrap.unwrap`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/wrap.html#MDAnalysis.transformations.wrap.unwrap).