Skip to main content

Derived Fields

An extensible, catalog-driven library for computing derived fields from multi-component engineering data arrays

Overview

vcti.derived turns multi-component engineering results — vectors, 6-DOF, symmetric stress/strain tensors — into derived fields such as magnitude, von Mises, principal values and directions, and traction vectors. The math is pure numpy, and the results land in a FieldSet: deriving a quantity registers it as a named, cached column and hands back a lens to it. That makes a derived value a first-class field — you can filter, sort, group, or export on it, build your own expressions over it, and the next derivation reuses it instead of recomputing (the principal values are solved once and feed a dozen further quantities). Three layers sit over one implementation: kernels (plain arrays in, arrays out), field lenses (ScalarField, VectorField, Dof6Field, SymmetricTensorField, ComplexField) over a FieldSet, and a catalog enumerating what exists per family with stable string and integer ids. Families are 3-D; 2-D data is embedded as 3-D by the caller. Component order is explicit, so data from any solver (Abaqus, Nastran, Ansys, LS-Dyna) computes correctly without reshuffling, and the output dtype is a promise this library keeps.

Installation

pip install vcti-derived[fieldset]

The core (kernels and catalog) needs only numpy. The [fieldset] extra adds the field lenses, which derive into a FieldSet.

In requirements.txt

vcti-derived[fieldset]>=4.0.0

In pyproject.toml dependencies

dependencies = [
    "vcti-derived[fieldset]>=4.0.0",
]

Quick Start

import numpy as np
from vcti.fieldset import FieldSet
from vcti.derived import DataFamily, SymmetricTensorField, catalogs, symtensor

# A stress tensor, one column per component
stress = np.array([[100.0, 20.0, 5.0, 15.0, 8.0, -12.0],
                   [300.0, 50.0, 10.0, 0.0, 0.0, 0.0]], dtype=np.float32)
fs = FieldSet(**{f"stress_{c}": stress[:, i].copy()
                 for i, c in enumerate(("xx", "yy", "zz", "xy", "yz", "xz"))})

field = SymmetricTensorField(fs, prefix="stress_")

# Deriving registers a named column and returns a lens to it
field.von_mises()            # -> ScalarField; fs now has "stress_von_mises"
field.max_principal()        # solves the eigenproblem once...
field.max_shear()            # ...and this reuses the cached "stress_principals"

# A derived value is an ordinary column, so it can drive what happens next
hot = fs.rows().where("stress_von_mises > 100").select()
SymmetricTensorField(hot, prefix="stress_").max_principal()   # continue on the subset

# Kernels directly, if you just have arrays:
vm = symtensor.von_mises(stress)                              # (N,)

# The catalog: what exists, and a container-free reference (accepts a permuted order)
entry = catalogs.get("symtensor.von_mises")                   # dispatch_id 7
vm = entry.compute(stress, order=["xx", "yy", "zz", "xy", "xz", "yz"])
for e in catalogs.scalar.by_family(DataFamily.SYMTENSOR):
    print(e.id, e.dispatch_id, e.display_name)

Dependencies

  • numpy — the only requirement of the core (kernels and catalog).

Optional

  • vcti-fieldset — required for the field lenses; install via vcti-derived[fieldset].

Documentation

If you want to… Read
Understand the architecture and design decisions docs/design.md
Navigate and understand the source docs/source-guide.md
See practical, real-world usage docs/patterns.md
Extend the library docs/extending.md

Metadata

Release files for vcti-derived 4.0.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 vcti-derived 4.0.0
File Size Uploaded Provenance Actions
vcti_derived-4.0.0.tar.gz 61.5 kB With provenance Details for vcti_derived-4.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vcti-derived 4.0.0
File Interpreter ABI Platform Actions
vcti_derived-4.0.0-py3-none-any.whl Python 3 none any Details for vcti_derived-4.0.0-py3-none-any.whl

Total release size: 110.4 kB

Release files / vcti_derived-4.0.0.tar.gz

Download URL vcti_derived-4.0.0.tar.gz
Size 61.5 kB
Tags Source
SHA-256 checksum
How to use checksums
2332e6cac1d1001cb9cebd05b9fb6444de4c5c3a8030f65169f0e430fc88be08
BLAKE2b-256 checksum
How to use checksums
2a72cd93293446dc5c0b9923bae51e0dc78616ac3db981b193e05751c700db07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.

Transparency log

Release files / vcti_derived-4.0.0-py3-none-any.whl

Download URL vcti_derived-4.0.0-py3-none-any.whl
Size 48.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce815c8e4e118041cbe8fdd0585f9f0b089010a1bdce791d227fdd1cc1e1f8f5
BLAKE2b-256 checksum
How to use checksums
edcfcf8443e0ad55f264ab8369404b2b277fb2b6b6f7c197113de3603e26e153
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.

Transparency log

Security for vcti-derived 4.0.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vcti_derived-4.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.

Transparency log

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.

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