From 5957b9c2e64f2b85846babed4df4864b2dc7581d Mon Sep 17 00:00:00 2001 From: Kale Weichman Date: Fri, 20 Dec 2024 17:02:59 -0500 Subject: [PATCH] cleaned up documentation --- lasy/laser.py | 6 +----- lasy/utils/laser_utils.py | 4 ++-- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/lasy/laser.py b/lasy/laser.py index d9427f61..ded36110 100644 --- a/lasy/laser.py +++ b/lasy/laser.py @@ -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 ---------- @@ -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) diff --git a/lasy/utils/laser_utils.py b/lasy/utils/laser_utils.py index df10c396..d76cee8f 100644 --- a/lasy/utils/laser_utils.py +++ b/lasy/utils/laser_utils.py @@ -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. @@ -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.