osiris-utils 1.2.3__tar.gz → 1.2.4__tar.gz

{osiris_utils-1.2.3 → osiris_utils-1.2.4}/CONTRIBUTING.rst

@@ -13,8 +13,7 @@ Reporting Bugs
 How do I submit a good bug report?
 ----------------------------------
 
-Bugs are tracked as GitHub issues:
-`https://github.com/joaopedrobiu6/osiris_utils/issues/`
+Bugs are tracked as GitHub `issues <https://github.com/joaopedrobiu6/osiris_utils/issues/>`_.
 
 To help maintainers reproduce (and fix) the problem quickly, please include:
 

{osiris_utils-1.2.3/osiris_utils.egg-info → osiris_utils-1.2.4}/PKG-INFO

@@ -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 → osiris_utils-1.2.4}/docs/source/api/sim_diag.rst

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

{osiris_utils-1.2.3 → osiris_utils-1.2.4}/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 → osiris_utils-1.2.4/osiris_utils.egg-info}/PKG-INFO

@@ -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