VTRTool
Python utilities for Fullwave3D VTR model files.
The package contains a vtrtool executable, as well as a vtrtool.py python package
Installation
This tool can be obtained from PyPI. Simply do:
pip install vtrtool
vtrtool executable quick usage
vtrtool -h to show usage information
vtrtool info my_model_file.vtr shows metadata info for my_model_file.vtr
vtrtool info nx1 my_model_file.vtr prints out just the size of the 1st (x) dimension for my_model_file.vtr
vtrtool to_binary --property=2 my_model_file.vtr my_model_file.bin to dump the 2nd property from my_model_file.vtr to the float32 raw binary file my_model_file.bin
vtrtool to_stdout my_model_file.vtr to pipe the 1st property (default) from my_model_file.vtr to stdout in raw float32 binary format
vtrtool.py Python module quick usage
The vtrtool.VTRModel class represents a vtr model that lives at a given filename. The file will be parsed on object initialization:
import vtrtool
# read the vtr file `my_model_file.vtr` and construct a new VTRModel object with it
vtr_model = vtrtool.VTRModel("my_model_file.vtr")
# print model properties to stdout
vtrtool.print_vtr_metadata(vtr_model)
# model property 1 will be available as numpy ndarray in
vtr_model.arrays[0]
# model property 2 (if it exists) will be available as numpy ndarray in
vtr_model.arrays[1]
# etc...
Set the optional keyword use_memmap=True if you want the VTRModel object to use a NumPy memmap instead of in-memory representation for holding the model array.
The following instance properties exist for objects of the VTRModel class:
- file: (str) the vtr filename referenced by the VTRModel object
- num_dimensions: (int) number of dimensions in the model
- num_attributes: (int) number of properties in the model
- shape: (tuple of ints) shape (c-based) of numpy ndarray holding the models in the order
(nx1, nx2, nx3) - shape_fortran: (tuple of ints) shape (fortran-based) of the models in the order
(nx3, nx2, nx1) - nx1: (int) number of cells in the 1st (usually x) dimension
- nx2: (int) number of cells in the 2nd (usually y) dimension
- nx3: (int) number of cells in the 3rd (fastest, usually z) dimension
- arrays: (list of ndarrays) holds the model property ndarrays, the length of the list correspond to the number of model properties (i.e., property 1 is in model[0]), and the shape of the ndarray will correspond to
shapeand with the number of dimensions innum_dimensions
Some convenience functions:
vtrtool.vtrfile_to_ndarray(filename, prop_index=0)quickly takes a vtr file and returns the property specified byprop_indexas an ndarrayvtrtool.print_vtr_metadata(vtrmodel_object)takes a VTRModel object and prints dimension information to stdout
Maintained by
Tim Lin tlin@s-cube.com, 2017
1 maintainer
Metadata
1 maintainer
Release files for vtrtool 0.8.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| vtrtool-0.8.6.tar.gz | 10.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vtrtool-0.8.6-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 23.8 kB
Release files / vtrtool-0.8.6.tar.gz
| Download URL | vtrtool-0.8.6.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d5b2b28787e607de9327044a2ae5aaccf7f1314816682b362e99c5fdd046173
|
|
BLAKE2b-256 checksum How to use checksums |
ab6a4cc5add24c5656af9d526249609ffb1c7ffc080f50795f265cca0fefe65c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7
|
Release files / vtrtool-0.8.6-py2.py3-none-any.whl
| Download URL | vtrtool-0.8.6-py2.py3-none-any.whl |
|---|---|
| Size | 13.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c94f810f85bf080de304ae3d82577a85523c43e1d8bf7eb32c3edd968439b272
|
|
BLAKE2b-256 checksum How to use checksums |
3eac010e547b9095c80aaddecced12608b2cb54058484020f09e4ebb7ad0378a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7
|
Security for vtrtool 0.8.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
