General simulation data file format.
Project description
GSD
GSD (General Simulation Data) is a file format specification and a library to read and write it. The package also contains a python module that reads and writes hoomd schema gsd files with an easy to use syntax.
See the full GSD documentation at readthedocs.io.
Overview
GSD files:
- Efficiently store many frames of data from simulation runs.
- High performance file read and write.
- Support arbitrary chunks of data in each frame (position, orientation, type, etc...).
- Append frames to an existing file with a monotonically increasing frame number.
- Resilient to job kills.
- Variable number of named chunks in each frame.
- Variable size of chunks in each frame.
- Each chunk identifies data type.
- Common use cases: NxM arrays in double, float, int, char types.
- Generic use case: binary blob of N bytes.
- Easy to integrate into other tools with python, or a C API (< 1k lines).
- Fast random access to frames.
HOOMD examples
Create a hoomd gsd file.
>>> s = gsd.hoomd.Snapshot()
>>> s.particles.N = 4
>>> s.particles.types = ['A', 'B']
>>> s.particles.typeid = [0,0,1,1]
>>> s.particles.position = [[0,0,0],[1,1,1], [-1,-1,-1], [1,-1,-1]]
>>> s.configuration.box = [3, 3, 3, 0, 0, 0]
>>> traj = gsd.hoomd.open(name='test.gsd', mode='wb')
>>> traj.append(s)
Append frames to a gsd file:
>>> def create_frame(i):
... s = gsd.hoomd.Snapshot();
... s.configuration.step = i;
... s.particles.N = 4+i;
... s.particles.position = numpy.random.random(size=(4+i,3))
... return s;
>>> with gsd.hoomd.open('test.gsd', 'ab') as t:
... t.extend( (create_frame(i) for i in range(10)) )
... print(len(t))
11
Randomly index frames:
>>> with gsd.hoomd.open('test.gsd', 'rb') as t:
... snap = t[5]
... print(snap.configuration.step)
4
... print(snap.particles.N)
8
... print(snap.particles.position)
[[ 0.56993282 0.42243481 0.5502916 ]
[ 0.36892486 0.38167036 0.27310368]
[ 0.04739023 0.13603486 0.196539 ]
[ 0.120232 0.91591144 0.99463677]
[ 0.79806316 0.16991436 0.15228257]
[ 0.13724308 0.14253527 0.02505 ]
[ 0.39287439 0.82519054 0.01613089]
[ 0.23150323 0.95167434 0.7715748 ]]
Slice frames:
>>> with gsd.hoomd.open('test.gsd', 'rb') as t:
... for s in t[5:-2]:
... print(s.configuration.step, end=' ')
4 5 6 7
File layer examples
with gsd.fl.open(name='file.gsd', mode='wb') as f:
f.write_chunk(name='position', data=numpy.array([[1,2,3],[4,5,6]], dtype=numpy.float32));
f.write_chunk(name='angle', data=numpy.array([0, 1], dtype=numpy.float32));
f.write_chunk(name='box', data=numpy.array([10, 10, 10], dtype=numpy.float32));
f.end_frame()
with gsd.fl.open(name='file.gsd', mode='rb') as f:
for i in range(1,f.nframes):
position = f.read_chunk(frame=i, name='position');
do_something(position);
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gsd-1.5.4.tar.gz
(199.2 kB
view hashes)
Built Distributions
Close
Hashes for gsd-1.5.4-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fd37f2c3b613af0255c107a7d9aa28c987b453122c061f79e4c5bb31aa744f0 |
|
MD5 | 5225b57d83b5485df0aa8dd45b04fb8d |
|
BLAKE2b-256 | 80c0164031d638e158d2b4976559854fc2448d3774b3f98caf5313b5e5736276 |
Close
Hashes for gsd-1.5.4-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bc148215f83b769847b43d8090e0c15800dfe4ccddcd91ec9af0ae2cf17ec76 |
|
MD5 | d52bbc55c9f946f9048029d86efbba45 |
|
BLAKE2b-256 | 8ad72e0ea76d05bfffbe368d83ce7f77234e0222e8faacd37b004b23fa7705a6 |
Close
Hashes for gsd-1.5.4-cp35-cp35m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4ac78a87c5d247f0f49b7ea2ee228c0532d53a86d8aa04b404ada6eb79026a7 |
|
MD5 | 706c8686ce3ab77ed48dbf6f5f4884f5 |
|
BLAKE2b-256 | c229c645959f23ab05427558b6d8f62161c4b2d51aaa048eb55e10b106407891 |
Close
Hashes for gsd-1.5.4-cp34-cp34m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b818811a6f76149a0675ed376b5345aa09c4b7467ab222ccb644f33716bc5fa |
|
MD5 | 967124e4bd5cbb7999b096bd31846c9f |
|
BLAKE2b-256 | 0a253dfecfb709781971dfbc44b7faeeeab2b27340a0bd850983662e946ca045 |
Close
Hashes for gsd-1.5.4-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43f77defb1d7a1e88c7012c3955006cde2f2a9bf4cb162f6019f063147fb110d |
|
MD5 | ec8cf919723a62cfb8b6159c18d50a25 |
|
BLAKE2b-256 | fc9bfc5fd0d05fbda26723b88851df1cb357d62f57b6e73d18388fe66287abe9 |
Close
Hashes for gsd-1.5.4-cp27-cp27m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9aef86ee4f7122a835f9b979b59b7f196bab054f2649f427a1fe58516a911284 |
|
MD5 | 722a02ead59c8228dc4d6958c36246fd |
|
BLAKE2b-256 | 133ec931082f2dc219c3c1fe97db5ba6b864f7ec687c4f549ea0d8bf9d621824 |