vcti-derived 1.0.0__tar.gz

vcti_derived-1.0.0/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2018-2026 Visual Collaboration Technologies Inc.
+All Rights Reserved.
+
+This software is proprietary and confidential. Unauthorized copying,
+distribution, or use of this software, via any medium, is strictly
+prohibited. Access is granted only to authorized VCollab developers
+and individuals explicitly authorized by Visual Collaboration
+Technologies Inc.

vcti_derived-1.0.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: vcti-derived
+Version: 1.0.0
+Summary: An extensible, catalog-driven library for computing derived fields from multi-component engineering data arrays
+Author: Visual Collaboration Technologies Inc.
+License-Expression: LicenseRef-Proprietary
+Project-URL: Repository, https://github.com/vcollab/vcti-python-derived
+Project-URL: Changelog, https://github.com/vcollab/vcti-python-derived/blob/main/CHANGELOG.md
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.3
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
+Provides-Extra: typecheck
+Requires-Dist: mypy; extra == "typecheck"
+Dynamic: license-file
+
+# Derived Fields
+
+An extensible, catalog-driven library for computing derived fields from multi-component engineering data arrays
+
+## Overview
+
+`vcti.derived` turns multi-component engineering result arrays — vectors,
+6-DOF, symmetric stress/strain tensors — into derived fields such as
+magnitude, von Mises, principal values and directions, and traction vectors.
+It is pure numpy: plain arrays in, plain arrays out, with output dtype
+following the input. Two faces sit over one implementation — bulk-first
+**kernels** you call directly, and a **catalog** that enumerates which derived
+fields exist per data family (with stable ids, display names, and parameters)
+for driving menus and pipelines. Component order is handled explicitly, so
+data from any solver (Abaqus, Nastran, Ansys, LS-Dyna) computes correctly
+without reshuffling.
+
+## Installation
+
+```bash
+pip install vcti-derived
+```
+
+### In `requirements.txt`
+
+```
+vcti-derived>=1.0.0
+```
+
+### In `pyproject.toml` dependencies
+
+```toml
+dependencies = [
+    "vcti-derived>=1.0.0",
+]
+```
+
+---
+
+## Quick Start
+
+```python
+import numpy as np
+from vcti.derived import CATALOG, ComponentOrder, DataFamily, symtensor
+
+stress = np.array([[100.0, 20.0, 5.0, 15.0, 0.0, 0.0]])  # (N, 6): xx yy zz xy yz xz
+
+# Kernels directly:
+vm = symtensor.von_mises(stress)                 # (N,) von Mises stress
+s1 = symtensor.principals(stress)[:, -1]         # (N,) max principal
+
+# Data from a solver with a different component order (zero-copy):
+vm = symtensor.von_mises(stress, order=ComponentOrder.ABAQUS)
+
+# Or through the catalog:
+entry = CATALOG.get("symtensor3d.von_mises")
+vm = entry.compute(stress)
+for entry in CATALOG.by_family(DataFamily.SYMTENSOR3D):
+    print(entry.id, entry.display_name)
+```
+
+---
+
+## Dependencies
+
+[numpy](https://numpy.org) only.
+
+---
+
+## Documentation
+
+| If you want to… | Read |
+|---|---|
+| Understand the architecture and design decisions | [docs/design.md](docs/design.md) |
+| Navigate and understand the source | [docs/source-guide.md](docs/source-guide.md) |
+| See practical, real-world usage | [docs/patterns.md](docs/patterns.md) |
+| Extend the library | [docs/extending.md](docs/extending.md) |
+| Look up a specific function or type | [docs/api.md](docs/api.md) |
+
+<!-- The section is required; drop rows for docs this package does not ship. -->

vcti_derived-1.0.0/README.md

@@ -0,0 +1,80 @@
+# Derived Fields
+
+An extensible, catalog-driven library for computing derived fields from multi-component engineering data arrays
+
+## Overview
+
+`vcti.derived` turns multi-component engineering result arrays — vectors,
+6-DOF, symmetric stress/strain tensors — into derived fields such as
+magnitude, von Mises, principal values and directions, and traction vectors.
+It is pure numpy: plain arrays in, plain arrays out, with output dtype
+following the input. Two faces sit over one implementation — bulk-first
+**kernels** you call directly, and a **catalog** that enumerates which derived
+fields exist per data family (with stable ids, display names, and parameters)
+for driving menus and pipelines. Component order is handled explicitly, so
+data from any solver (Abaqus, Nastran, Ansys, LS-Dyna) computes correctly
+without reshuffling.
+
+## Installation
+
+```bash
+pip install vcti-derived
+```
+
+### In `requirements.txt`
+
+```
+vcti-derived>=1.0.0
+```
+
+### In `pyproject.toml` dependencies
+
+```toml
+dependencies = [
+    "vcti-derived>=1.0.0",
+]
+```
+
+---
+
+## Quick Start
+
+```python
+import numpy as np
+from vcti.derived import CATALOG, ComponentOrder, DataFamily, symtensor
+
+stress = np.array([[100.0, 20.0, 5.0, 15.0, 0.0, 0.0]])  # (N, 6): xx yy zz xy yz xz
+
+# Kernels directly:
+vm = symtensor.von_mises(stress)                 # (N,) von Mises stress
+s1 = symtensor.principals(stress)[:, -1]         # (N,) max principal
+
+# Data from a solver with a different component order (zero-copy):
+vm = symtensor.von_mises(stress, order=ComponentOrder.ABAQUS)
+
+# Or through the catalog:
+entry = CATALOG.get("symtensor3d.von_mises")
+vm = entry.compute(stress)
+for entry in CATALOG.by_family(DataFamily.SYMTENSOR3D):
+    print(entry.id, entry.display_name)
+```
+
+---
+
+## Dependencies
+
+[numpy](https://numpy.org) only.
+
+---
+
+## Documentation
+
+| If you want to… | Read |
+|---|---|
+| Understand the architecture and design decisions | [docs/design.md](docs/design.md) |
+| Navigate and understand the source | [docs/source-guide.md](docs/source-guide.md) |
+| See practical, real-world usage | [docs/patterns.md](docs/patterns.md) |
+| Extend the library | [docs/extending.md](docs/extending.md) |
+| Look up a specific function or type | [docs/api.md](docs/api.md) |
+
+<!-- The section is required; drop rows for docs this package does not ship. -->

vcti_derived-1.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vcti-derived"
+version = "1.0.0"
+description = "An extensible, catalog-driven library for computing derived fields from multi-component engineering data arrays"
+readme = "README.md"
+authors = [
+    {name = "Visual Collaboration Technologies Inc."}
+]
+license = "LicenseRef-Proprietary"
+license-files = ["LICENSE"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.12,<3.15"
+dependencies = ["numpy>=2.3"]
+
+[project.urls]
+Repository = "https://github.com/vcollab/vcti-python-derived"
+Changelog = "https://github.com/vcollab/vcti-python-derived/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["vcti.derived", "vcti.derived.*"]
+
+[tool.setuptools.package-data]
+"vcti.derived" = ["py.typed"]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-cov"]
+lint = ["ruff"]
+typecheck = ["mypy"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=vcti.derived --cov-report=term-missing --cov-fail-under=95"
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src"]
+namespace_packages = true
+explicit_package_bases = true
+mypy_path = ["src"]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_also = [
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+    "@(abc\\.)?abstractmethod",
+    "\\.\\.\\.",
+]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 99
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP"]

vcti_derived-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vcti_derived-1.0.0/src/vcti/derived/__init__.py

@@ -0,0 +1,34 @@
+# Copyright Visual Collaboration Technologies Inc. All Rights Reserved.
+# See LICENSE for details.
+"""vcti.derived — An extensible, catalog-driven library for computing
+derived fields from multi-component engineering data arrays.
+"""
+
+from importlib.metadata import version
+
+from . import dof6, ranges, scalar, symtensor, vector
+from .catalog import CATALOG, Catalog, Context, DerivedField, OutputKind, Parameter
+from .families import CANONICAL_COMPONENTS, DataFamily
+from .order import ComponentOrder, OrderLike, SolverOrder
+
+__version__ = version("vcti-derived")
+
+__all__ = [
+    "CANONICAL_COMPONENTS",
+    "CATALOG",
+    "Catalog",
+    "ComponentOrder",
+    "Context",
+    "DataFamily",
+    "DerivedField",
+    "OrderLike",
+    "OutputKind",
+    "Parameter",
+    "SolverOrder",
+    "__version__",
+    "dof6",
+    "ranges",
+    "scalar",
+    "symtensor",
+    "vector",
+]