osiris-utils 1.1.3__tar.gz → 1.1.6__tar.gz

{osiris_utils-1.1.3/osiris_utils.egg-info → osiris_utils-1.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osiris_utils
-Version: 1.1.3
+Version: 1.1.6
 Summary: Utilities to manipulate and visualize OSIRIS framework output data
 Author: ['João Pedro Ferreira Biu', 'João Cândido', 'Diogo Carvalho']
 Author-email: ['joaopedrofbiu@tecnico.ulisboa.pt']
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: numpy
@@ -48,6 +48,10 @@ OSIRIS_UTILS
 |Pypi|
 
 This package contains a set of utilities to open and analyze OSIRIS output files, using Python. All the methods implemented are fully integrated with `NumPy`, and use `np.ndarray` as the main data structure.
+High-level functions are provided to manipulate data from OSIRIS, from reading the data of the diagnostics, to making post-processing calculations.
+
+All code is written in Python. To contact the dev team, please send an email to João Biu: `joaopedrofbiu@tecnico.ulisboa.pt <mailto:joaopedrofbiu@tecnico.ulisboa.pt>`_.
+The full dev team can be found below in the Authors and Contributors section.
 
 How to install it?
 ------------------
@@ -58,6 +62,12 @@ To install this package, you can use `pip`::
 
 To install it from source, you can clone this repository and run (in the folder containing ``setup.py``)::
 
+    git clone https://github.com/joaopedrobiu6/osiris_utils.git
+    pip install .
+
+Finally, you can install it in editor mode if you want to contribute to the code::
+    
+    git clone https://github.com/joaopedrobiu6/osiris_utils.git
     pip install -e .
 
 Documentation
@@ -69,3 +79,11 @@ The documentation is available at https://osiris-utils.readthedocs.io or via thi
     :target: https://pypi.org/project/osiris-utils/
     :alt: Pypi
 
+.. _authors:
+
+Authors and Contributors
+------------------------
+
+- João Biu
+- João Cândido
+- Diogo Carvalho

{osiris_utils-1.1.3 → osiris_utils-1.1.6}/README.rst

@@ -3,6 +3,10 @@ OSIRIS_UTILS
 |Pypi|
 
 This package contains a set of utilities to open and analyze OSIRIS output files, using Python. All the methods implemented are fully integrated with `NumPy`, and use `np.ndarray` as the main data structure.
+High-level functions are provided to manipulate data from OSIRIS, from reading the data of the diagnostics, to making post-processing calculations.
+
+All code is written in Python. To contact the dev team, please send an email to João Biu: `joaopedrofbiu@tecnico.ulisboa.pt <mailto:joaopedrofbiu@tecnico.ulisboa.pt>`_.
+The full dev team can be found below in the Authors and Contributors section.
 
 How to install it?
 ------------------
@@ -13,6 +17,12 @@ To install this package, you can use `pip`::
 
 To install it from source, you can clone this repository and run (in the folder containing ``setup.py``)::
 
+    git clone https://github.com/joaopedrobiu6/osiris_utils.git
+    pip install .
+
+Finally, you can install it in editor mode if you want to contribute to the code::
+    
+    git clone https://github.com/joaopedrobiu6/osiris_utils.git
     pip install -e .
 
 Documentation
@@ -24,3 +34,11 @@ The documentation is available at https://osiris-utils.readthedocs.io or via thi
     :target: https://pypi.org/project/osiris-utils/
     :alt: Pypi
 
+.. _authors:
+
+Authors and Contributors
+------------------------
+
+- João Biu
+- João Cândido
+- Diogo Carvalho

osiris_utils-1.1.6/osiris_utils/__init__.py

@@ -0,0 +1,34 @@
+from .utils import (
+    time_estimation,
+    filesize_estimation,
+    transverse_average,
+    integrate,
+    save_data,
+    read_data,
+    courant2D,
+)
+from .gui.gui import LAVA_Qt, LAVA
+from .data.data import OsirisGridFile, OsirisRawFile, OsirisData, OsirisHIST, OsirisTrackFile
+from .data.simulation import Simulation, Species_Handler
+from .data.diagnostic import Diagnostic
+
+from .decks.decks import InputDeckIO
+from .decks.species import Specie
+
+from .postprocessing.postprocess import PostProcess
+from .postprocessing.derivative import Derivative_Simulation, Derivative_Diagnostic
+from .postprocessing.fft import FFT_Diagnostic, FastFourierTransform_Simulation
+
+from .postprocessing.mft_for_gridfile import MFT_Single
+from .postprocessing.mft import (
+    MeanFieldTheory_Simulation,
+    MFT_Diagnostic,
+    MFT_Diagnostic_Average,
+    MFT_Diagnostic_Fluctuations,
+)
+
+from .postprocessing.field_centering import FieldCentering_Simulation, FieldCentering_Diagnostic
+
+from .postprocessing.pressure_correction import PressureCorrection_Simulation, PressureCorrection_Diagnostic
+
+from .postprocessing.heatflux_correction import HeatfluxCorrection_Simulation, HeatfluxCorrection_Diagnostic