Skip to content

Commit 6245332

Browse files
committed
docs: simplify plot_phase
1 parent 6df7a5d commit 6245332

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

src/flekspy/amrex/plotting.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -207,21 +207,22 @@ def plot_phase(
207207
This function creates a 2D weighted histogram to visualize the particle
208208
density. This function first calls `get_phase_space_density` to compute
209209
the histogram and then plots the result.
210+
See more about the args in `get_phase_space_density`
210211
211212
Args:
212-
x_variable (str): The variable for the x-axis. See `get_phase_space_density`.
213-
y_variable (str): The variable for the y-axis. See `get_phase_space_density`.
214-
bins (int or tuple, optional): Bins for the histogram. See `get_phase_space_density`.
215-
hist_range (list, optional): Edges for bins. See `get_phase_space_density`.
216-
x_range (tuple, optional): Boundary for the x-axis. See `get_phase_space_density`.
217-
y_range (tuple, optional): Boundary for the y-axis. See `get_phase_space_density`.
218-
z_range (tuple, optional): Boundary for the z-axis. See `get_phase_space_density`.
219-
normalize (bool, optional): Normalize the density. See `get_phase_space_density`.
213+
x_variable (str): The variable for the x-axis.
214+
y_variable (str): The variable for the y-axis.
215+
bins (int or tuple, optional): Bins for the histogram.
216+
hist_range (list, optional): Edges for bins.
217+
x_range (tuple, optional): Boundary for the x-axis.
218+
y_range (tuple, optional): Boundary for the y-axis.
219+
z_range (tuple, optional): Boundary for the z-axis.
220+
normalize (bool, optional): Normalize the density.
220221
log_scale (bool, optional): If True, the colorbar is plotted in log scale.
221222
Defaults to True.
222-
use_kde (bool, optional): Use KDE. See `get_phase_space_density`.
223-
kde_bandwidth (str or float, optional): Bandwidth for KDE. See `get_phase_space_density`.
224-
kde_grid_size (int, optional): Grid points for KDE. See `get_phase_space_density`.
223+
use_kde (bool, optional): Use KDE.
224+
kde_bandwidth (str or float, optional): Bandwidth for KDE.
225+
kde_grid_size (int, optional): Grid points for KDE.
225226
plot_zero_lines (bool, optional): If True, plot dashed lines at x=0 and y=0.
226227
Defaults to True.
227228
title (str, optional): The title for the plot. Defaults to "Phase Space Distribution".
@@ -234,7 +235,6 @@ def plot_phase(
234235
This parameter is ignored if `marginals` is True.
235236
Defaults to True.
236237
transform (callable, optional): A function to transform particle data.
237-
See `get_phase_space_density`.
238238
**imshow_kwargs: Additional keyword arguments to be passed to `ax.imshow()`.
239239
This can be used to control colormaps (`cmap`), normalization (`norm`), etc.
240240
Returns:

0 commit comments

Comments
 (0)