Update doc

This commit is contained in:
rstiskalek 2023-06-05 17:11:30 +01:00
parent e89edf0af4
commit 07bb03b15d

View file

@ -180,10 +180,9 @@ def field2rsp(field, parts, box, nbatch=30, flip_partsxz=True, init_value=0.,
---------- ----------
field : 3-dimensional array of shape `(grid, grid, grid)` field : 3-dimensional array of shape `(grid, grid, grid)`
Real space field to be evolved to redshift space. Real space field to be evolved to redshift space.
parts_pos : 2-dimensional array of shape `(n_parts, 3)` parts : 2-dimensional array of shape `(n_parts, 6)`
Particle positions in real space. Particle positions and velocities in real space. Must be organised as
parts_vel : 2-dimensional array of shape `(n_parts, 3)` `x, y, z, vx, vy, vz`.
Particle velocities in real space.
box : :py:class:`csiborgtools.read.CSiBORGBox` box : :py:class:`csiborgtools.read.CSiBORGBox`
The simulation box information and transformations. The simulation box information and transformations.
nbatch : int, optional nbatch : int, optional