osiris-utils 1.2.3__py3-none-any.whl → 1.2.4__py3-none-any.whl

docs/source/api/sim_diag.rst

@@ -48,7 +48,7 @@ Usage examples
 ~~~~~~~~~~~~~~
 
 Basic access (lazy)
-^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 

osiris_utils/postprocessing/fft.py

@@ -19,12 +19,10 @@ class FFT_Simulation(PostProcess):
 
     Parameters
     ----------
-
     simulation : Simulation
         The simulation object.
-    axis : int
-        The axis to compute the FFT.
-
+    fft_axis : int or list of int
+        The axis or axes to compute the FFT.
     """
 
     def __init__(self, simulation: Simulation, fft_axis: int | list[int]) -> None:
@@ -84,13 +82,13 @@ class FFT_Diagnostic(Diagnostic):
     Methods
     -------
     load_all() -> np.ndarray
-        Load all data and compute FFT (possibly including time axis). Returns power spectrum |FFT|^2 stored in self._data.
-    _frame(index: int, data_slice: tuple | None = None) -> np.ndarray
+        Load all data and compute FFT (possibly including time axis). Returns power spectrum \|FFT\|^2 stored in self._data.
+    _frame(index: int, data_slice: tuple \| None = None) -> np.ndarray
         Per-timestep (lazy) FFT. Only allowed for spatial FFT. If fft_axis includes time (0), user must call load_all().
-        Returns power spectrum |FFT|^2.
+        Returns power spectrum \|FFT\|^2.
     omega() -> np.ndarray
         Get the angular frequency array for the FFT along the time dimension.
-    k(axis: int | None = None) -> np.ndarray | dict[int, np.ndarray]
+    k(axis: int \| None = None) -> np.ndarray \| dict[int, np.ndarray]
         Get the wavenumber array for the FFT along spatial dimension(s).
     """
 
@@ -102,7 +100,7 @@ class FFT_Diagnostic(Diagnostic):
         window: str | None = "hann",  # "hann" or None
         window_for_spatial: str | None = None,  # default None if periodic; override if desired
         detrend: str | None = "mean",  # "mean" or None
-        normalize: str = "ortho",  # "none" | "ortho" | "density"
+        normalize: str = "ortho",  # "none" or "ortho" or "density"
         assume_periodic: bool = False,  # affects default windowing for spatial FFT)
     ) -> None:
         if hasattr(diagnostic, "_species"):
@@ -161,7 +159,7 @@ class FFT_Diagnostic(Diagnostic):
     def load_all(self) -> np.ndarray:
         """
         Load all data and compute FFT (possibly including time axis).
-        Returns power spectrum |FFT|^2 stored in self._data.
+        Returns power spectrum \|FFT\|^2 stored in self._data.
         """
         if self._data is not None:
             print("Using cached data.")
@@ -218,7 +216,7 @@ class FFT_Diagnostic(Diagnostic):
         """
         Per-timestep (lazy) FFT. Only allowed for spatial FFT.
         If fft_axis includes time (0), user must call load_all().
-        Returns power spectrum |FFT|^2.
+        Returns power spectrum \|FFT\|^2.
         """
         axes_osiris = [self._fft_axis] if isinstance(self._fft_axis, int) else list(self._fft_axis)
 

{osiris_utils-1.2.3.dist-info → osiris_utils-1.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osiris_utils
-Version: 1.2.3
+Version: 1.2.4
 Summary: Utilities to manipulate and visualise OSIRIS plasma PIC output data
 Author-email: João Pedro Ferreira Biu <joaopedrofbiu@tecnico.ulisboa.pt>
 License: MIT

{osiris_utils-1.2.3.dist-info → osiris_utils-1.2.4.dist-info}/RECORD

@@ -9,7 +9,7 @@ docs/source/_static/custom.css,sha256=KJO7s8zlu2_16WICQB7U5NTfcJelwmHmA1Uj3WqfSL
 docs/source/_static/quick_start_ez.png,sha256=_pxXBOTl30EMkCcbiehp-F0vk-nd8r9VF25Cz4tORPU,50829
 docs/source/api/decks.rst,sha256=iTcMUiSSlb7rmqzwLG4T5bjShFiAWdSIsDBWQljkbwE,1147
 docs/source/api/postprocess.rst,sha256=Tv0BPBRQhol844LB4_4mKaIdA3wvi1ZMAfC9E_pjWI4,11849
-docs/source/api/sim_diag.rst,sha256=J1cRvdAkIOBwh_Y9jPB2Js_5Wyj9pyQmgly-uEUwe58,7593
+docs/source/api/sim_diag.rst,sha256=AFmhZHVm08gu9XOvHjozcQvzmdE-c2Akp9d4PULLtoU,7594
 docs/source/api/utilities.rst,sha256=DlJVDykwuoN7YEF6e75UbSG3fQiCNbcDGM89mNMOcUI,9599
 docs/source/examples/example_Derivatives.md,sha256=p0tLobnmLyFKPkDSeFshKpzYi4rYVjBnn2oo_ekcB7g,2378
 docs/source/examples/example_FFT.md,sha256=JbFNm0C8EVEhnY6vTiKFD2IKBVwFoCpv-35OcrzRl7M,6086
@@ -99,7 +99,7 @@ osiris_utils/decks/decks.py,sha256=pQ1xdl4VKRskHjTQMzfOtLFIBipM0XQCkg4-lfSSMfo,1
 osiris_utils/decks/species.py,sha256=f8BY-Zb_LhHP5KFlkQNbzF3uQZl7vtDKXHXZvlKzps8,1106
 osiris_utils/postprocessing/__init__.py,sha256=bN8YlzTXd1Kr8eYqyWtGv8WFF0N_9f5XlsN1uUIHyLc,1180
 osiris_utils/postprocessing/derivative.py,sha256=yNf40zl7BemGstI1_SQ6t5YmNzoOvbBG1z9zXuVhEnk,22713
-osiris_utils/postprocessing/fft.py,sha256=Tim7AUF2m4iFkhpJFhcgcF1dWFxvzmwOzPDCsdSl-9I,18693
+osiris_utils/postprocessing/fft.py,sha256=hF8m-8wc8XPLB0GYI2FIkSm-aelfajb8CHKKTLy2Y1s,18731
 osiris_utils/postprocessing/field_centering.py,sha256=dRkQOUMEsrfZjy0JTpRIclk7dRuLV55sooF9zzhxNxc,7745
 osiris_utils/postprocessing/heatflux_correction.py,sha256=oBIJnyJT_FLMM9sCjL8d9TCh6EcJpa15rwd2a7GKuvE,8079
 osiris_utils/postprocessing/mft.py,sha256=2BvbXTms53TUO3jYGvR_OqwEPjRcNk5yAbJe9Aqzg5w,7856
@@ -107,9 +107,9 @@ osiris_utils/postprocessing/postprocess.py,sha256=HWxkioPw3qJkialhYntkm5WG4o1xVf
 osiris_utils/postprocessing/pressure_correction.py,sha256=_QxejZdLotazJl5wOFurpsVbbUDS1DFL7-MIQta0O3c,6042
 osiris_utils/vis/__init__.py,sha256=Vr0o8wtRFtPOJdSK5cRIa_bDvbylAe2sHTk8c7qO_tM,51
 osiris_utils/vis/plot3d.py,sha256=MYRlc_T6rY7WpwZdEAlorhOMu9FbVw2-iOqjXGE7rrc,4694
-osiris_utils-1.2.3.dist-info/licenses/LICENSE.txt,sha256=z1lVzLA_QsfcnLffhfWMrFw5cR_nuwpvbOGCOFUN7iY,1066
-osiris_utils-1.2.3.dist-info/METADATA,sha256=wwFPPj0ScYyKyFkBiAH9NPwQWXCyVf7zwFdTcUCzCmc,5582
-osiris_utils-1.2.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-osiris_utils-1.2.3.dist-info/entry_points.txt,sha256=s3WXJWsWF5AWEFhJ8rXscjGttQCOXvViOiNmX45AJjo,49
-osiris_utils-1.2.3.dist-info/top_level.txt,sha256=tSs2XcOs-JtYsqVepo5WVSNcilf6ALHfKyYuPaVZLco,38
-osiris_utils-1.2.3.dist-info/RECORD,,
+osiris_utils-1.2.4.dist-info/licenses/LICENSE.txt,sha256=z1lVzLA_QsfcnLffhfWMrFw5cR_nuwpvbOGCOFUN7iY,1066
+osiris_utils-1.2.4.dist-info/METADATA,sha256=s6O7aRYdlPhbK5ZV3pA1fOkT1lX6FIETEv24Gbgtq20,5582
+osiris_utils-1.2.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+osiris_utils-1.2.4.dist-info/entry_points.txt,sha256=s3WXJWsWF5AWEFhJ8rXscjGttQCOXvViOiNmX45AJjo,49
+osiris_utils-1.2.4.dist-info/top_level.txt,sha256=tSs2XcOs-JtYsqVepo5WVSNcilf6ALHfKyYuPaVZLco,38
+osiris_utils-1.2.4.dist-info/RECORD,,