Skip to content

Commit

Permalink
Merge pull request #2373 from thepith/fix_vtf_doc
Browse files Browse the repository at this point in the history
Fixing minor typos in the vtf documentation
  • Loading branch information
fweik authored Nov 12, 2018
2 parents f80bd28 + 4d5deb0 commit 26faf0f
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions doc/sphinx/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ a whole simulation in a single file. For more details on the format,
refer to the VTF homepage (https://github.com/olenz/vtfplugin/wiki).

Creating files in these formats from within is supported by the commands :meth:`espressomd.io.writer.vtf.writevsf`
and :meth:`espressomd.io.writer.vtf.writevcf`, that write a structure and coordinate block (respectively ) to the
and :meth:`espressomd.io.writer.vtf.writevcf`, that write a structure and coordinate block (respectively) to the
given file. To create a standalone VTF file, first use ``writevsf`` at the beginning of
the simulation to write the particle definitions as a header, and then ``writevcf``
to generate a timeframe of the simulation state. For example:
Expand All @@ -344,7 +344,7 @@ A standalone VTF file can simply be
# ... add particles here
# write structure block as header
vtf.writevtf(system, fp)
vtf.writevsf(system, fp)
# write initial positions as coordinate block
vtf.writevcf(system, fp)
Expand All @@ -359,7 +359,7 @@ can easily add further structure lines to the VTF/VSF file after a
structure block has been written to specify further particle properties
for visualization.

Note that the ``ids`` of the particles in and VMD may differ. VMD requires
Note that the ``ids`` of the particles in |es| and VMD may differ. VMD requires
the particle ids to be enumerated continuously without any holes, while
this is not required in |es|. When using ``writevsf``
and ``writevcf``, the particle ids are
Expand All @@ -380,8 +380,7 @@ timesteps. This is a restriction of VMD itself, not of the format.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:meth:`espressomd.io.writer.vtf.writevsf`

Writes a structure block describing the system's structure to the given channel.
for example
Writes a structure block describing the system's structure to the given channel, for example:

.. code:: python
Expand Down

0 comments on commit 26faf0f

Please sign in to comment.