turbx 1.0.2__py3-none-any.whl

turbx/ztmd_loader.py

@@ -0,0 +1,56 @@
+import os
+import types
+
+import h5py
+import numpy as np
+
+# ======================================================================
+
+def ztmd_loader(fn,names):
+    '''
+    Loader function for ZTMD files, return blank object with datasets attached
+    '''
+    
+    if not os.path.isfile(fn):
+        raise FileNotFoundError(fn)
+    
+    obj = types.SimpleNamespace()
+    
+    with h5py.File(fn,'r') as hf:
+        
+        ## 0D: Attach top-level attributes
+        for k,v in hf.attrs.items():
+            setattr(obj, k, v)
+        
+        ## tmp
+        obj.mu_inf    = obj.mu_Suth_ref*(obj.T_inf/obj.T_Suth_ref)**(3/2) * ((obj.T_Suth_ref+obj.S_Suth)/(obj.T_inf+obj.S_Suth))
+        obj.rho_inf   = obj.p_inf/(obj.R*obj.T_inf)
+        obj.nu_inf    = obj.mu_inf/obj.rho_inf
+        obj.a_inf     = np.sqrt(obj.kappa*obj.R*obj.T_inf)
+        obj.U_inf     = obj.Ma*obj.a_inf
+        obj.cp        = obj.R*obj.kappa/(obj.kappa-1.)
+        obj.cv        = obj.cp/obj.kappa
+        obj.recov_fac = obj.Pr**(1/3)
+        obj.Taw       = obj.T_inf + obj.recov_fac*obj.U_inf**2/(2*obj.cp)
+        obj.lchar     = obj.Re*obj.nu_inf/obj.U_inf
+        
+        ## 1D: Attach contents of group dims/
+        if 'dims' in hf:
+            for dsn in hf['dims']:
+                ds = hf[f'dims/{dsn}']
+                setattr(obj, dsn, ds[()])
+        
+        ## 1D: Attach contents of group data_1Dx/
+        if 'data_1Dx' in hf:
+            for dsn in hf['data_1Dx']:
+                ds = hf[f'data_1Dx/{dsn}']
+                setattr(obj, dsn, ds[()])
+        
+        ## 2D : Attach contents of group data/
+        if 'data' in hf:
+            for dsn in hf['data']:
+                if dsn in names: ## only load if explicitly asked for
+                    ds = hf[f'data/{dsn}']
+                    setattr(obj, dsn, ds[()].T)
+    
+    return obj

turbx-1.0.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 iagappel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

turbx-1.0.2.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.2
+Name: turbx
+Version: 1.0.2
+Summary: Extensible toolkit for analyzing turbulent flow datasets
+Author: Jason A
+Maintainer: Jason A
+License: MIT
+Keywords: turbulence,fluid mechanics,DNS,MPI,HPC
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: Database
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mpi4py>=4.0
+Requires-Dist: numpy>=2.0
+Requires-Dist: scipy>=1.14
+Requires-Dist: h5py>=3.11
+Requires-Dist: matplotlib>=3.9
+Requires-Dist: tqdm>=4.66
+Requires-Dist: psutil>=6.0
+Provides-Extra: dev
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pyright>=1.1; extra == "dev"
+
+# turbx
+[![PyPI version](https://badge.fury.io/py/turbx.svg)](https://badge.fury.io/py/turbx)
+[![Downloads](https://pepy.tech/badge/turbx)](https://pepy.tech/project/turbx)
+<!---
+[![pipeline status](https://gitlab.iag.uni-stuttgart.de/transi/turbx/badges/master/pipeline.svg)](https://gitlab.iag.uni-stuttgart.de/transi/turbx/-/commits/master)
+-->
+
+## About
+
+`turbx` is a package for processing turbulent flow datasets. Primary data access classes are `super()`ed wrappers of `h5py.File` that make data & metadata access tidy and performant. Workloads requiring heavy I/O and compute are made scalable using parallelization and high-performance collective MPI-IO.
+
+## Pre-installation requirements
+
+### `h5py`
+`turbx` is designed to be used with parallel-mode `h5py`, the `python3` API for `HDF5`. Most basic workflows will still work transparently with the basic serial install of `h5py`, however data-heavy workflows will require the full API functionality. This requires:
+
+- A parallel `HDF5` installation
+- `h5py` built with `HDF5_MPI="ON"`; see [h5py docs](https://docs.h5py.org/en/stable/mpi.html)
+
+<br>
+
+Confirm that `h5py` was built with MPI support:
+```python
+>>> import h5py
+>>> h5py.get_config().mpi
+True
+```
+
+
+### `mpi4py`
+
+High-performance collective MPI-IO and MPI operations are handled with `mpi4py`. This requires:
+
+- An MPI implementation such as `OpenMPI` or `MPICH`
+- `mpi4py`; see [mpi4py docs](https://mpi4py.readthedocs.io/en/stable/install.html)
+
+
+
+
+## Installation
+
+### TL;DR
+Install binary directly from [PyPI](https://pypi.org/project/turbx):
+
+```
+python3 -m pip install --upgrade turbx
+```
+
+---
+
+### Non-root install with `--user`
+
+The `--user` flag can be added to install to `~/.local/lib/pythonX.Y/site-packages` rather than `site-packages` of the `python3` installation itself. This is often required for HPC environments where installing packages for the system `python3` is not allowed for regular users.
+
+<br>
+
+### Editable installs
+
+`turbx` can also be installed from source in `editable` mode (see [setuptools docs](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)). Once the source is acquired (PyPI or GitLab), the source can be installed from the project root folder:
+
+```
+python3 -m pip install --upgrade -e .
+```
+
+<br>
+
+### Installing on systems with no outbound network access
+
+If the restricted install environment requires `devpi-server`:
+
+
+**On a local machine with internet access:**
+```
+devpi-server
+```
+
+**On a local machine with internet access:**
+```
+ssh -R <remote_port>:localhost:<local_devpi_port> user@domain.com
+```
+
+- `<local_devpi_port>` is the port on which `devpi-server` is running locally
+- `<remote_port>` is an arbitrary free port on the system login node used to expose the mirror remotely
+- After connecting, the PyPI mirror will be reachable on the server side at: `http://localhost:<remote_port>`
+
+**On the remote system:**
+```
+python3 -m pip install --upgrade [--user] [--editable] --index-url http://localhost:<remote_port>/root/pypi/+simple/ <package-or-path>
+```
+

turbx-1.0.2.dist-info/RECORD

@@ -0,0 +1,41 @@
+turbx/__init__.py,sha256=y9u_gPAfDSbZB_Cmf-lcQ8RpMeMxjUBeA9RnzwWtPpo,1371
+turbx/bl.py,sha256=lFyhPvgOMbzY9as9pvBNGJRlsiY_cvYbyCUC9cOxB0k,18183
+turbx/blasius.py,sha256=aDvTWMWo1oKehkQjhjwSQYonHOBF5sqzieXxZYZ7-IU,2128
+turbx/cli.py,sha256=ZEvG7TCcGT6V7nOd46zXa71VrvDQpaxpKT9EvmH8r08,504
+turbx/composite_profile.py,sha256=iGQdvtbua4p0h9oUWTFLsasvLKz7fy_bXKh-MEbIUd0,8901
+turbx/confidence_interval.py,sha256=Y8Ke6gYH5RALxzDLJWWbJoB30aBB46uEBLvcUJsQ-0M,2184
+turbx/eas3.py,sha256=XxaCjArLGQ_qP6zUrTYEgLrsEA1V1SJrIErnE3CnkbM,17906
+turbx/eas4.py,sha256=gmKakvFfs_7sRHI8zmKbXszJarcfc7jwF4nGFGWjjcM,26713
+turbx/fig_ax_constructor.py,sha256=o9D1Sk_vo2Q5E7HEI5UofKECSqKqF8LMl7VpOkn7qFA,1491
+turbx/freestream_parameters.py,sha256=H_XmgOt78mdd1Ru2gd2fUeSO1ZUIjOc7A0pV1NwVjU4,12583
+turbx/gradient.py,sha256=H7EdzQstlnZueAJeuH_5ts0CII89h42dAfEwMBJnkVQ,14377
+turbx/grid_metric.py,sha256=n_iYC8dlusTLi4-n9pByZfG_MWFs7mvUJwMMVF91nlQ,10787
+turbx/h5.py,sha256=XIjd0MnLp83fYCkAJv5AqxbhZlNXvnV_SksCnTaebKI,9094
+turbx/mvp.py,sha256=W3kvMN8t2uWGEpTDH03P_W0Gw5Fz2BysKcK2e26-VWs,12035
+turbx/rgd.py,sha256=FSNcuI3c_v_7TpoLIUa7n12CWGlxsx8nNqeuo_IJZd4,129597
+turbx/rgd_mean.py,sha256=sMyz9K6Pki2Rq2P9d2gEHhFx_ASTaHAgIK-RM9fDEFE,21840
+turbx/rgd_testing.py,sha256=M3c4F2SsJeqU5t4jcgXansI9bumWr_C_QLaUPZEe9QU,12836
+turbx/rgd_xpln_ccor.py,sha256=fDik9G9RsoVWxRQQs3qKAa8tcsocWgrUazvg7n6Wcxk,29637
+turbx/rgd_xpln_coh.py,sha256=xTX4FTig7Dp6qXFhWdoeOcvuJY3E8l0W0n0J-Rv_mCM,40989
+turbx/rgd_xpln_mean_dim.py,sha256=iKVnMJRI8WtCAkEivs49bOwQzUTZFX7kPITX0ddLb1M,14099
+turbx/rgd_xpln_spectrum.py,sha256=0TwIdQIEAnNjMjbWYS0VdLzzuaQDjzfeyda9Gs45r84,38332
+turbx/rgd_xpln_stats.py,sha256=gvrl-1CKQF6B8menlB29JEVoRh-cQW1m9HL3N54YXOw,32522
+turbx/rgd_xpln_turb_budget.py,sha256=EyHHatJZb1Kfuts9HDH2pXHFdJ8J3o9-KojT0NSXzDU,52785
+turbx/set_mpl_env.py,sha256=-1h5bqI2FUcqOSbOVW2-hQzKv-h9OzagBVzAk5S01Rw,3195
+turbx/signal.py,sha256=cvnBwbpaIO6uPdedvZeQCzqk93bpAIggThdF-ynNVnM,8842
+turbx/spd.py,sha256=OreeuAEnrL9wkYBpCi-dI8_hAAqt_mRGd2jzAdalJOw,55150
+turbx/spd_wall_ccor.py,sha256=2YKyW01BfW9h5wh3iwoCs1-tqxOq1N7rS7pY3LUDmBs,26063
+turbx/spd_wall_ci.py,sha256=UBFAqd3AQ3n77NtHeHklmFKQAC2uBStQ0DmFOyw908g,14750
+turbx/spd_wall_import.py,sha256=dpqWpNMiM3S6sAGDde_afBnpjzMvtQpHyLAfhKG6Dh0,27830
+turbx/spd_wall_spectrum.py,sha256=Qbua9fWrRk4Ap9FqrPnliI6mqGHdXAek9J3Fljb1oOE,25805
+turbx/spd_wall_stats.py,sha256=sG2i7P1FOqxL2xHEWuZfgZcQvyyFrnqRA5u22vBICOE,26664
+turbx/utils.py,sha256=mQtrZaU3BI_SXi02Tze55q4ZR8cS5Vtb4R73fgDjCzc,2317
+turbx/ztmd.py,sha256=P-TQRBGfUVwErkoVs9EAH9s4p7EWsokbwXgl7EMsnCw,113405
+turbx/ztmd_analysis.py,sha256=r8DHoTeYA6yzSniwsefjo9fEI3LvowIzKC33vefTlU8,87734
+turbx/ztmd_loader.py,sha256=BebSmoxUYKWk16_xFoRQ04AoU8Mfr_JFb5kkr2yJmNI,1839
+turbx-1.0.2.dist-info/LICENSE,sha256=jpVnztpA1ZGgf3THAye-vf4NiJ2YclY6U5KODPnANxo,1065
+turbx-1.0.2.dist-info/METADATA,sha256=wDVbBF7RFSn4yRHeAuJhv5qc1c8bN8sRsZcdfxjfx10,4033
+turbx-1.0.2.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+turbx-1.0.2.dist-info/entry_points.txt,sha256=_krRugpZJMkvcAox_g0T1KqCXfbQ4MARyspQMSAIkVA,41
+turbx-1.0.2.dist-info/top_level.txt,sha256=LPn4NGmMN4N44Virr-EaKGcVGcbWNVmT171RUWnGOPs,6
+turbx-1.0.2.dist-info/RECORD,,

turbx-1.0.2.dist-info/WHEEL

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

turbx-1.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+turbx = turbx.cli:main

turbx-1.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+turbx