Skip to content

Commit

Permalink
Merge pull request #4707 from chrishavlin/override_bins_profile
Browse files Browse the repository at this point in the history
  • Loading branch information
neutrinoceros authored Nov 2, 2023
2 parents c2f8d50 + 01543db commit 89cb1b4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions yt/data_objects/data_containers.py
Original file line number Diff line number Diff line change
Expand Up @@ -1169,6 +1169,8 @@ def profile(
accumulation=False,
fractional=False,
deposition="ngp",
*,
override_bins=None,
):
r"""
Create a 1, 2, or 3D profile object from this data_source.
Expand Down Expand Up @@ -1214,8 +1216,11 @@ def profile(
distribution function.
deposition : Controls the type of deposition used for ParticlePhasePlots.
Valid choices are 'ngp' and 'cic'. Default is 'ngp'. This parameter is
ignored the if the input fields are not of particle type.
ignored if the input fields are not of particle type.
override_bins : dict of bins to profile plot with
If set, ignores n_bins and extrema settings and uses the
supplied bins to profile the field. If a units dict is provided,
bins are understood to be in the units specified in the dictionary.
Examples
--------
Expand Down Expand Up @@ -1246,6 +1251,7 @@ def profile(
accumulation,
fractional,
deposition,
override_bins=override_bins,
)
return p

Expand Down
2 changes: 1 addition & 1 deletion yt/data_objects/profiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -1263,7 +1263,7 @@ def create_profile(
deposition : strings
Controls the type of deposition used for ParticlePhasePlots.
Valid choices are 'ngp' and 'cic'. Default is 'ngp'. This parameter is
ignored the if the input fields are not of particle type.
ignored if the input fields are not of particle type.
override_bins : dict of bins to profile plot with
If set, ignores n_bins and extrema settings and uses the
supplied bins to profile the field. If a units dict is provided,
Expand Down

0 comments on commit 89cb1b4

Please sign in to comment.