Add docs for the wrap transformation

p-j-smith · Sep 14, 2023 · 34d592d · 34d592d
1 parent 2c59527
commit 34d592d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/docs/movies/mda-tui-wrap.mp4 b/docs/movies/mda-tui-wrap.mp4
diff --git a/docs/transformations/index.md b/docs/transformations/index.md
@@ -1,6 +1,7 @@
 # Transformations
 
-There are currently two transformations available in MDAnalysis TUI:
+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)
diff --git a/docs/transformations/wrap.md b/docs/transformations/wrap.md
@@ -0,0 +1,7 @@
+# Wrap
+
+Wrap atoms into the unit cell using [`MDAnalysis.transformations.wrap.wrap`](https://docs.mdanalysis.org/stable/documentation_pages/transformations/wrap.html#MDAnalysis.transformations.wrap.wrap).
+
+<video controls>
+  <source src="../../movies/mda-tui-wrap.mp4" type="video/mp4">
+</video>