Plot3D Utilities

A python plot3D library for reading, writing, finding connectivity, and post processing for Plot3D data files.

Install Instructions

To install simply do a pip install plot3d

Link to documentation

Building the docs

  1. From the repo root, run pip install uv (if you don't already have uv) then uv sync --extra docs (and commit the refreshed uv.lock) to capture the new Sphinx dependencies.
  2. Build locally with uv run sphinx-build -b html docs docs/_build/html or use uv run sphinx-autobuild for live previews.
  3. Push the branch to main, then enable GitHub Pages (Settings → Pages → “GitHub Actions”) so the new workflow can deploy your merged Sphinx docs automatically.

Metis

Metis is used to group the blocks to be evaluated. So say you have 1000 blocks and 8 CPU. The blocks are split up and sent to the CPU or GPU. The split is done with weighting to block size and connectivity this way each processor is evaluating similar number of nodes. Plot3D Library will work without metis but metis functionality wont be available.

Partitioning is backed by metis-rs, a pure Rust reimplementation of METIS with Python bindings. It ships as a prebuilt wheel, so pip install plot3d (which pulls in metis-rs) is all that's needed on Linux, Mac, and Windows — no separate METIS install, no compiler, and no METIS_DLL/LD_LIBRARY_PATH setup required.

Tutorials

Reading Writing and Viewing Plot3D files

Read/Write File Formats (Binary, ASCII, Fortran, Endianness)

Periodicity with axially rotated and copied blocks

Translated periodicity

Merging Blocks

Flatten a mesh into a finite-volume graph, and solve on it: a converging-diverging duct

Cross-plane connectivity: why some face matches need more than lb/ub

Learning Python with VSCode

Learning Bash for Automating Tasks

Tips

Never use jupyter notebook unless you are done with your .py file and want to demo code. Jupyter is painful for debugging.

Useful VS Code Extensions

Contributors

Name Position Dates Contribution
Paht Juangphanich Owner 2021- Creator https://github.com/pjuangph
David Rigby Advisor Fall 2021 Block splitting help
Christopher Keokot Intern Fall 2021 Plot3D ReactJS GUI
Tim Beach Advisor Fall 2021 Block splitting help

Connectivity & Orientation

connectivity_fast() finds matching faces between blocks and returns orientation data for each match. When two faces lie on different constant planes (e.g., a K-face connects to a J-face), the varying axes differ and an axis swap may be needed. This is encoded as a permutation_index (0–7) using 3 bits:

Bit Flag Meaning
0 u_reversed Flip first varying axis
1 v_reversed Flip second varying axis
2 swapped Transpose u and v axes

Each face match includes an orientation dict:

face_matches, outer_faces = connectivity_fast(blocks)
# Each match in face_matches has:
#   match['orientation'] = {
#       'permutation_index': int,   # 0-7
#       'plane': str,               # 'in-plane' or 'cross-plane'
#       'permutation_matrix': list  # 2x2 signed permutation matrix
#   }

The 8 permutation matrices are also available as plot3d.PERMUTATION_MATRICES.

Documentation

Rust Version

The rust version is available here. This version of the code is useful for creating CFD solvers in rust Plot3D-RS It has most of the functionality of the python version except for some of the GlennHT pre-processing code.

Funding

The development of this library was supported by NASA AATT (Advance Air Transport Technology). The development is supported by NASA Glenn LTE Branch. Anyone is welcome to contribute by submitting a pull request.

License

NASA Open Source Agreement

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for pjuangph from gravatar.com pjuangph

Credits

Author: Paht Juangphanich

Requires

Python >=3.10.12

Provides Extra

docs examples hdf5

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plot3d-1.11.1.tar.gz (75.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plot3d-1.11.1-py3-none-any.whl (156.2 kB view details)

Uploaded Python 3

File details

Details for the file plot3d-1.11.1.tar.gz.

File metadata

  • Download URL: plot3d-1.11.1.tar.gz
  • Upload date:
  • Size: 75.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for plot3d-1.11.1.tar.gz
Algorithm Hash digest
SHA256 017522b531c6b171e5ddd2954a49b0090590f385b7678491335cd213fe66825f
MD5 ddb678620fe00c5c89964dee71a6f4c3
BLAKE2b-256 0b04e1936c60ddc7743f8f22a90eec29be2194985d01a58c13f3d6304410fade

See more details on using hashes here.

Provenance

The following attestation bundles were made for plot3d-1.11.1.tar.gz:

Publisher: publish.yml on nasa/Plot3D_utilities

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plot3d-1.11.1-py3-none-any.whl.

File metadata

  • Download URL: plot3d-1.11.1-py3-none-any.whl
  • Upload date:
  • Size: 156.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for plot3d-1.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 616003bbf6e46d9030dc3095843c0ce769baa15f0924993cfd2bbb8f98b2a85e
MD5 4407f6619fa6e5163da369147f58df98
BLAKE2b-256 681e7c056fe7fc4e13bce846873bac8fb8af026cb4668ff69b58227e6c9bfe58

See more details on using hashes here.

Provenance

The following attestation bundles were made for plot3d-1.11.1-py3-none-any.whl:

Publisher: publish.yml on nasa/Plot3D_utilities

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.11.1 This release

2 files

1.10.1

2 files

1.10.0

2 files

1.9.5

2 files

1.9.4

2 files

1.9.3

2 files

1.9.2

2 files

1.9.1

2 files

1.9.0

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.14

2 files

1.7.13

2 files

1.7.12

2 files

1.7.11

2 files

1.7.10

2 files

1.7.9

2 files

1.7.8

2 files

1.7.7

2 files

1.7.6

2 files

1.7.5

2 files

1.7.4

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.9

2 files

1.6.8

2 files

1.6.7

2 files

1.6.6

1 file

1.6.5

2 files

1.6.4

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.16

2 files

1.5.15

2 files

1.5.14

2 files

1.5.13

2 files

1.5.12

2 files

1.5.11

2 files

1.5.10

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4.1

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

0.1.5

1 file

0.1.4

1 file

0.1.3

2 files

0.1.2

1 file

0.1.1

1 file

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