Skip to content

Commit

Permalink
cleaned up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kale-j committed Dec 20, 2024
1 parent 6f43b9a commit 5957b9c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
6 changes: 1 addition & 5 deletions lasy/laser.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def __init__(

def normalize(self, value, kind="energy"):
"""
Normalize the pulse either to the energy, peak field amplitude, peak intensity, or average intensity.
Normalize the pulse either to the energy, peak field amplitude, peak intensity, or average intensity. The average intensity option operates on the envelope.
Parameters
----------
Expand All @@ -157,10 +157,6 @@ def normalize(self, value, kind="energy"):
kind : string (optional)
Distance by which the laser pulse should be propagated
Options: ``'energy``', ``'field'``, ``'intensity'``, ``'average_intensity'`` (default is ``'energy'``)
Notes
-----
The normalization to average intensity operates on the intensity envelope
"""
if kind == "energy":
normalize_energy(self.dim, value, self.grid)
Expand Down
4 changes: 2 additions & 2 deletions lasy/utils/laser_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ def normalize_peak_intensity(peak_intensity, grid):
Parameters
----------
peak_intensity : scalar (W/m^2)
Peak field amplitude of the laser pulse after normalization.
Peak intensity of the laser pulse after normalization.
grid : a Grid object
Contains value of the laser envelope and metadata.
Expand All @@ -140,7 +140,7 @@ def normalize_average_intensity(average_intensity, grid):
Parameters
----------
average_intensity : scalar (W/m^2)
Average field amplitude of the laser pulse after normalization.
Average intensity of the laser pulse envelope after normalization.
grid : a Grid object
Contains value of the laser envelope and metadata.
Expand Down

0 comments on commit 5957b9c

Please sign in to comment.