osiris-utils 1.1.2__py3-none-any.whl → 1.1.4__py3-none-any.whl

osiris_utils/utils.py

@@ -24,7 +24,7 @@ def courant2D(dx, dy):
     dt = 1 / (np.sqrt(1/dx**2 + 1/dy**2))
     return dt
 
-def time_estimation(n_cells, ppc, push_time, t_steps, n_cpu, hours = False):
+def time_estimation(n_cells, ppc, t_steps, n_cpu, push_time = 1e-7, hours = False):
     '''
     Estimate the simulation time.
 
@@ -106,45 +106,6 @@ def integrate(array, dx):
     int = -scipy.integrate.cumulative_simpson(flip_array, dx = dx, initial = 0)
     return np.flip(int)
 
-def animate_2D(datafiles, frames, interval, fps, savename, **kwargs):
-    '''
-    Animate 2D OSIRIS files.
-
-    Parameters
-    ----------
-    datafiles : str
-        The path to the files.
-        Must be of the type 'path/to/file_%06d.h5'.
-    kwargs : dict
-        Additional keyword arguments for plotting.
-
-    Returns
-    -------
-    matplotlib.animation.FuncAnimation
-        The animation.
-    '''
-    fig, ax = plt.subplots(figsize=(12, 6), tight_layout=True)
-    im = 0
-
-    def animate(i):
-        # Assuming this returns (x, y, data, out) correctly
-        x, y, data, _ = open2D(datafiles % i)
-        ax.clear()
-        # Display image data, make sure data shape is valid for imshow
-        im = ax.imshow(-data, extent=[x.min(), x.max(), y.min(), y.max()], aspect='auto', origin='lower', **kwargs)
-        plt.xlabel(r'x [c/$\omega_p$]')
-        plt.ylabel(r'y [c/$\omega_p$]')
-        
-
-    # Creating the animation, and frames should be updated accordingly
-    ani = animation.FuncAnimation(fig, animate, frames=frames, interval=interval)
-
-    # Save the animation as a GIF (you can set the path and filename)
-    ani.save(savename, writer='pillow', fps=fps)  # fps can be adjusted
-
-    # Display the animation
-    return ani
-
 def save_data(data, savename, option='numpy'):
     """
     Save the data to a .txt (with Numpy) or .csv (with Pandas) file.

{osiris_utils-1.1.2.dist-info → osiris_utils-1.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osiris_utils
-Version: 1.1.2
+Version: 1.1.4
 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.4.dist-info/RECORD

@@ -0,0 +1,22 @@
+osiris_utils/__init__.py,sha256=X9n7gUvc4oYjLn8nPY3f-Rm77l7ByrvQvwet_FvsTfo,856
+osiris_utils/utils.py,sha256=D-WyvksBl1LGHgYWHeUx2PIPhBVjGFpfuuHlf9EPzbU,3472
+osiris_utils/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osiris_utils/data/data.py,sha256=tEmjM_2IOp6P3OjBL1zesLQ52V2V5XHF7No1VDUkG4M,15938
+osiris_utils/data/diagnostic.py,sha256=fJk7J48H4_0W4TImNhyCAH_hbjOSCia71_WUgFgfJNo,38344
+osiris_utils/data/simulation.py,sha256=anLjjHCWlfoMg9F8WmiGXMTLberFEorE1aAe4zSSAms,6719
+osiris_utils/decks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osiris_utils/decks/decks.py,sha256=Ug1_fSfZL9iJwn7dnTvHM0k1Zc4kGpI427QvO0V2pwg,10173
+osiris_utils/decks/species.py,sha256=uZA1oMSltofc2m1s3rK__wjxXfTAQ_3wB2aKRG_PmKo,1066
+osiris_utils/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osiris_utils/gui/gui.py,sha256=s4not0GzHI3CrA4uQVnjt9jFavkVAeGbQ6rJpM4jir4,10538
+osiris_utils/postprocessing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osiris_utils/postprocessing/derivative.py,sha256=bS_qVdsdgmfNKmxGMV1d5jCwwVpeiGDb_jYI-GLLFUI,10152
+osiris_utils/postprocessing/fft.py,sha256=zu59iBOpsoRMBPgUTqLTas__qZvZSFz_tuEODxaER9E,9159
+osiris_utils/postprocessing/mft.py,sha256=wnDguPz1v0sDxtxEfHBXxb2ywaNwAznQMlMtOfd4N9I,12537
+osiris_utils/postprocessing/mft_for_gridfile.py,sha256=ZaLgwsND9nbD-v-JfCZYxh7-dz3RA-IILwBjZnZGCiE,1522
+osiris_utils/postprocessing/postprocess.py,sha256=f2ZXLnAvLpsLFd-Pygb_sYxwkU4zn1OoF_byVKYAPII,1115
+osiris_utils-1.1.4.dist-info/licenses/LICENSE.txt,sha256=Cawy2v7wKc7n8yL8guFu-cH9sQw9r1gll1pEFPFAB-Q,1084
+osiris_utils-1.1.4.dist-info/METADATA,sha256=lbpLiKYzdLQc0HLRF15GAlbCsCxMzzytVfbn8ORGrec,3070
+osiris_utils-1.1.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+osiris_utils-1.1.4.dist-info/top_level.txt,sha256=mM-_dX5fjzIKB7te655PhZOrPACVY-bJmiASCqW1eOA,13
+osiris_utils-1.1.4.dist-info/RECORD,,

{osiris_utils-1.1.2.dist-info → osiris_utils-1.1.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

osiris_utils-1.1.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-osiris_utils/__init__.py,sha256=MUWaLyViH0S_HLSDxMJJo_KMhXp40sTJS2ahgWWd0iw,752
-osiris_utils/utils.py,sha256=pj2hrmZla-6T_95eRZB_c4TSXJqBvNRvMTzuw1lPZyA,4708
-osiris_utils-1.1.2.dist-info/licenses/LICENSE.txt,sha256=Cawy2v7wKc7n8yL8guFu-cH9sQw9r1gll1pEFPFAB-Q,1084
-osiris_utils-1.1.2.dist-info/METADATA,sha256=-A1dCd0uVTABjyyGG8cbsuZslMs111LfcKurQZYhFW4,2327
-osiris_utils-1.1.2.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-osiris_utils-1.1.2.dist-info/top_level.txt,sha256=mM-_dX5fjzIKB7te655PhZOrPACVY-bJmiASCqW1eOA,13
-osiris_utils-1.1.2.dist-info/RECORD,,