pylag.processing.input module

Tools to assist with the creation of PyLag initial position files

pylag.processing.input.create_initial_positions_file_multi_group(filename, release_zones)[source]

Create an initial positions file for multiple particle groups

Take a list of ReleaseZone objects, extract particle initial positions and write to file.

Expected file format is:

n

group_id_1 xpos_1 ypos_1 zpos_1

group_id_1 xpos_2 ypos_2 zpos_2

…

group_id_2 xpos_n ypos_n zpos_n

where n is the total number of particles, {x,y,z}pos_i is the initial x/y/z position of particle i (i= 1 to n) in UTM coordinates, and group_id_1 is an integer specifying the group to which the particle belongs.

Parameters

filename (string) – Output file name (either local or full path)
release_zones (ReleaseZone, iterable) – List or array of release zone objects each containing an arbitrary number of particles.

pylag.processing.input.create_initial_positions_file_single_group(filename, n, group_id, xpos, ypos, zpos)[source]

Create an initial positions file for a single group of particles

Create a file specifying the initial positions of a set of n particles. Each particle has the same group ID.