Skip to main content

## TBNN-s v0.5.0 - Tensor Basis Neural Network for Scalar Mixing

This package implements the vanilla Tensor Basis Neural Network [1] as the TBNN class, and also the Tensor Basis Neural Network for Scalar Flux Modeling [2] as the TBNNS class. They are described in the following references:

[1] Ling, Kurzawski, Templeton. “Reynolds averaged turbulence modelling using deep neural networks with embedded invariance.” J. Fluid Mech. 807 (2016)

[2] Milani, Ling, Eaton. “Turbulent scalar flux in inclined jets in crossflow: counter gradient transport and deep learning modelling” J. Fluid Mech. (under review)

Author: Pedro M. Milani (email: pmmilani@stanford.edu)

Last modified: 08/06/2020

Developed and tested in Python 3.7 using tensorflow 1.15

### Installation To install, run the following (optionally within a virtual environment):

pip install tbnns [–user] [–upgrade]

This will install the stable version from the Python Package Index. Use the flag –user in case you do not have administrator privileges and the flag –upgrade to get the newest version.

To test the program while it is being developed, run the command below from the current directory. This is useful when you are developing the code.

pip install -e .

To uninstall, run:

pip uninstall tbnns

The commands above will also install some dependencies (included in the file “requirements.txt”) needed for this package.

### Examples and Testing

The folder test contains a script example_usage.py and three representative datasets. For an example of training a TBNN-s and applying it to a test set, run the following inside the folder test:

python example_usage_tbnns.py

python example_usage_tbnn.py

Metadata

Release files for tbnns 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tbnns 0.5.0
File Size Uploaded
tbnns-0.5.0.tar.gz 35.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tbnns 0.5.0
File Interpreter ABI Platform
tbnns-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 75.5 kB

Release files / tbnns-0.5.0.tar.gz

Download URL tbnns-0.5.0.tar.gz
Size 35.6 kB
Tags Source
SHA-256 checksum
How to use checksums
b7462a3d6ecd4fd8c96befe71e2ac0a8ef33290432f984be7e35be1701d6772d
BLAKE2b-256 checksum
How to use checksums
a92289c28012c3a8970824b4eb0e8d2622be929b2b1f9d40a4b33bcdf1f90cfa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Release files / tbnns-0.5.0-py3-none-any.whl

Download URL tbnns-0.5.0-py3-none-any.whl
Size 39.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7e746dfdcb5eec5e3c2ac05e6300ed4a6dae697b265ae08979e876b24192320a
BLAKE2b-256 checksum
How to use checksums
fceaa73adbf17c286c012102fa8231ad99302eed557dafcc69c80c5a17f9a8ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page