1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
.. Copyright (c) 2016-2025 The Regents of the University of Michigan
.. Part of GSD, released under the BSD 2-Clause License.
GSD documentation
+++++++++++++++++
The **GSD** file format is the native file format for `HOOMD-blue <https://glotzerlab.engin.umich.edu/hoomd-blue/>`_.
**GSD** files store trajectories of the HOOMD-blue system state in a binary file with efficient random access to
frames. **GSD** allows all particle and topology properties to vary from one frame to the next. Use the **GSD** Python
API to specify the initial condition for a HOOMD-blue simulation or analyze trajectory output with a script. Read a
**GSD** trajectory with a visualization tool to explore the behavior of the simulation.
* `GitHub Repository <https://github.com/glotzerlab/gsd>`_: **GSD** source code and issue tracker.
* `HOOMD-blue <https://glotzerlab.engin.umich.edu/hoomd-blue/>`_: Simulation engine that reads and writes GSD files.
* `GSD discussion board <https://github.com/glotzerlab/gsd/discussions/>`_:
Ask the **GSD** user community for help.
* `freud <https://freud.readthedocs.io>`_: A powerful set of tools for analyzing trajectories.
* `OVITO <https://www.ovito.org/>`_: The Open Visualization Tool works with GSD files.
* `gsd-vmd plugin <https://github.com/mphoward/gsd-vmd>`_: VMD plugin to support GSD files.
.. toctree::
:maxdepth: 1
:caption: Getting started
installation
changes
community
.. toctree::
:maxdepth: 1
:caption: Tutorials
hoomd-examples
fl-examples
.. toctree::
:maxdepth: 1
:caption: Reference
python-api
cli
c-api
specification
.. toctree::
:maxdepth: 1
:caption: Contributing
contributing
style
.. toctree::
:maxdepth: 1
:caption: Additional information
credits
license
indices
|