Aquila-Consortium/csiborgtools
0
0
Fork 0
mirror of https://github.com/Richard-Sti/csiborgtools_public.git synced 2025-05-21 01:51:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Delete boring comments

Browse source
This commit is contained in:
rstiskalek 2023-10-19 16:25:48 +01:00
parent 692a50ee1a
commit 630c64cc11
1 changed files with 2 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

17
csiborgtools/field/density.py
View file

@ -33,13 +33,7 @@ class BaseField(ABC):
@property @property
def box(self): def box(self):
""" """Simulation box information and transformations."""
Simulation box information and transformations.
Returns
-------
:py:class:`csiborgtools.units.CSiBORGBox`
"""
return self._box return self._box
@box.setter @box.setter
@ -52,13 +46,7 @@ class BaseField(ABC):
@property @property
def MAS(self): def MAS(self):
""" """Mass-assignment scheme."""
Mass-assignment scheme.
Returns
-------
str
"""
if self._MAS is None: if self._MAS is None:
raise ValueError("`MAS` is not set.") raise ValueError("`MAS` is not set.")
return self._MAS return self._MAS
@ -103,7 +91,6 @@ class DensityField(BaseField):
Calculate the overdensity field from the density field. Calculate the overdensity field from the density field.
Defined as :math:`\rho/ <\rho> - 1`. Overwrites the input array. Defined as :math:`\rho/ <\rho> - 1`. Overwrites the input array.
Parameters Parameters
---------- ----------
delta : 3-dimensional array of shape `(grid, grid, grid)` delta : 3-dimensional array of shape `(grid, grid, grid)`