humex 0.2.0__tar.gz

humex-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 humex contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

humex-0.2.0/NOTICE

@@ -0,0 +1,27 @@
+humex
+Copyright 2026 humex contributors
+
+This product is licensed under the Apache License, Version 2.0
+(see the LICENSE file in this repository).
+
+----------------------------------------------------------------------
+
+Bundled / vendored components
+-----------------------------
+
+humex vendors the following components, all of which were originally
+authored by humex contributors and are released under the same Apache
+License, Version 2.0 as humex itself:
+
+  * The Protocol Buffer schemas under ``proto/`` and the generated
+    Python bindings under ``src/humex/proto/``.
+  * The dataset converters under ``src/humex/converters/`` (Waymo,
+    DROID-100, LAFAN1).
+  * The HD-map subsystem under ``src/humex/hmap/`` (``HMap`` facade,
+    ``LaneMap``, ``RoadMap``, role table builder).
+
+No third-party source code is bundled in this distribution. Required
+third-party libraries (numpy, scipy, shapely, protobuf, click, rich,
+PyYAML, requests, networkx) are installed at runtime via pip and
+remain governed by their respective upstream licenses (BSD, MIT,
+Apache 2.0, MPL 2.0).

humex-0.2.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: humex
+Version: 0.2.0
+Summary: Behavioral metrics for autonomous-vehicle and physical-AI scenarios
+Author-email: humex contributors <humex@zerothlaw.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/zerothlaw-ai/humex
+Project-URL: Source, https://github.com/zerothlaw-ai/humex
+Project-URL: Issues, https://github.com/zerothlaw-ai/humex/issues
+Keywords: autonomous-vehicles,robotics,scenarios,metrics,simulation,waymo,droid,lafan
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy<3,>=1.23
+Requires-Dist: shapely<3,>=2.0
+Requires-Dist: scipy>=1.10
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: protobuf<5,>=3.20
+Requires-Dist: networkx>=2.6
+Requires-Dist: requests>=2.28.0
+Requires-Dist: click>=8
+Requires-Dist: rich>=13
+Provides-Extra: local
+Requires-Dist: matplotlib<4.0,>=3.6.1; extra == "local"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=3.0; extra == "test"
+Provides-Extra: waymo
+Requires-Dist: humex-converter-waymo; extra == "waymo"
+Provides-Extra: droid
+Requires-Dist: humex-converter-droid; extra == "droid"
+Provides-Extra: lafan
+Requires-Dist: humex-converter-lafan; extra == "lafan"
+Provides-Extra: all
+Requires-Dist: humex-converter-waymo; extra == "all"
+Requires-Dist: humex-converter-droid; extra == "all"
+Requires-Dist: humex-converter-lafan; extra == "all"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Dynamic: license-file
+
+# humex (core)
+
+**Hu**man-**U**nderstandable **ME**trics for everything (**X**) — behavioral
+metrics for autonomous-vehicle and physical-AI scenarios.
+
+This is the core `humex` package — `ScenarioAPI`, `HMap`, metric DAGs,
+monitors, and the CLI. **Converters ship as separate packages** so heavy
+deps (TensorFlow for Waymo, pyarrow/pandas for DROID, …) don't get
+pulled into a clean `humex` install.
+
+```bash
+pip install humex                          # core only
+pip install humex[all]                     # core + all bundled converters
+pip install humex humex-converter-waymo    # core + just Waymo
+```
+
+See the [workspace README](../README.md) for the full picture.

humex-0.2.0/README.md

@@ -0,0 +1,17 @@
+# humex (core)
+
+**Hu**man-**U**nderstandable **ME**trics for everything (**X**) — behavioral
+metrics for autonomous-vehicle and physical-AI scenarios.
+
+This is the core `humex` package — `ScenarioAPI`, `HMap`, metric DAGs,
+monitors, and the CLI. **Converters ship as separate packages** so heavy
+deps (TensorFlow for Waymo, pyarrow/pandas for DROID, …) don't get
+pulled into a clean `humex` install.
+
+```bash
+pip install humex                          # core only
+pip install humex[all]                     # core + all bundled converters
+pip install humex humex-converter-waymo    # core + just Waymo
+```
+
+See the [workspace README](../README.md) for the full picture.

humex-0.2.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["setuptools>=80", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "humex"
+version = "0.2.0"
+description = "Behavioral metrics for autonomous-vehicle and physical-AI scenarios"
+authors = [{name = "humex contributors", email = "humex@zerothlaw.io"}]
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+keywords = [
+    "autonomous-vehicles",
+    "robotics",
+    "scenarios",
+    "metrics",
+    "simulation",
+    "waymo",
+    "droid",
+    "lafan",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "numpy>=1.23,<3",
+    "shapely>=2.0,<3",
+    "scipy>=1.10",
+    "PyYAML>=6.0",
+    "protobuf>=3.20,<5",
+    "networkx>=2.6",
+    "requests>=2.28.0",
+    "click>=8",
+    "rich>=13",
+]
+
+[project.optional-dependencies]
+local = [
+    "matplotlib>=3.6.1,<4.0",
+]
+test = [
+    "pytest>=7.0",
+    "pytest-cov>=3.0",
+]
+# Convenience meta-extras for installing converter plugins alongside the
+# core. Each plugin is its own PyPI package with its own deps; these
+# extras just bundle them so `pip install humex[all]` keeps working for
+# users who want the same one-line install as before the split.
+waymo = ["humex-converter-waymo"]
+droid = ["humex-converter-droid"]
+lafan = ["humex-converter-lafan"]
+all = [
+    "humex-converter-waymo",
+    "humex-converter-droid",
+    "humex-converter-lafan",
+]
+dev = [
+    "ruff>=0.4.0",
+    "mypy>=1.8",
+]
+
+[project.urls]
+Homepage = "https://github.com/zerothlaw-ai/humex"
+Source = "https://github.com/zerothlaw-ai/humex"
+Issues = "https://github.com/zerothlaw-ai/humex/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"humex.api.ai_api.prompts" = ["*.txt"]
+"humex.proto" = ["*.pyi", "py.typed"]
+
+[project.scripts]
+humex = "humex.cli.main:cli"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra --strict-markers"

humex-0.2.0/setup.cfg

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

humex-0.2.0/src/humex/__init__.py

@@ -0,0 +1,50 @@
+"""humex — behavioral metrics for autonomous-vehicle and physical-AI scenarios.
+
+High-level Python APIs for:
+- Loading and preparing scenarios
+- Analyzing scenarios with metrics
+- Converting and computing metric DAGs
+- Natural language interaction via LLM
+
+See ``humex.api.core_apis`` for a comprehensive facade listing all public APIs
+with full signatures, parameter descriptions, and usage examples::
+
+    import humex.api.core_apis
+    help(humex.api.core_apis)
+
+    from humex.api.core_apis import (
+        analyze,
+        ScenarioAPI,
+        ConvertAnalyzerMetricsAPI,
+        ComputeAnalyzerMetricsAPI,
+    )
+"""
+
+from .api import (
+    Chat,
+    ScenarioAPI,
+    ConvertAnalyzerMetricsAPI,
+    ComputeAnalyzerMetricsAPI,
+)
+from .hmap import HMap, LaneMap, RoadMap, RoleTable, build_lane_map, build_role_table
+
+__version__ = "0.2.0"
+
+# Plugin-API version. Converter plugins may declare a ``MIN_HUMEX_API_VERSION``
+# class attr; the registry skips converters whose minimum exceeds this value
+# instead of letting an incompatible plugin crash the host. Bump on breaking
+# changes to BaseConverter / ConversionResult / registry contracts.
+__api_version__ = 1
+
+__all__ = [
+    "ScenarioAPI",
+    "ConvertAnalyzerMetricsAPI",
+    "ComputeAnalyzerMetricsAPI",
+    "Chat",
+    "HMap",
+    "LaneMap",
+    "RoadMap",
+    "RoleTable",
+    "build_lane_map",
+    "build_role_table",
+]

humex-0.2.0/src/humex/api/__init__.py

@@ -0,0 +1,28 @@
+"""High-level API for humex framework.
+
+This module provides convenient Python functions and classes for analyzing scenarios,
+loading scenarios, converting metrics configs, and interacting with humex via natural language.
+
+Classes:
+- ScenarioAPI: Load scenarios from various sources
+- ConvertAnalyzerMetricsAPI: Convert analyzer configs to DAG format
+- ComputeAnalyzerMetricsAPI: End-to-end metrics computation
+- Chat: LLM chat interface
+- TranslateMetrics: Natural language to metrics config translator
+
+Functions (for backward compatibility):
+- chat(): Functional chat interface
+- translate_metrics(): Functional metrics translation interface
+"""
+
+from .scenario_api import ScenarioAPI
+from .metrics_api import ConvertAnalyzerMetricsAPI, ComputeAnalyzerMetricsAPI
+from .ai_api import Chat, TranslateMetrics
+
+__all__ = [
+    'ScenarioAPI',
+    'ConvertAnalyzerMetricsAPI',
+    'ComputeAnalyzerMetricsAPI',
+    'Chat',
+    'TranslateMetrics',
+]

humex-0.2.0/src/humex/api/ai_api/__init__.py

@@ -0,0 +1,18 @@
+"""AI API module providing LLM integration with pluggable model support.
+
+This module provides interfaces to various AI models (currently Claude via Claude CLI)
+for tasks like chat interactions and metrics requirement translation.
+
+Classes:
+- Chat: Class-based chat interface
+- TranslateMetrics: Class-based metrics translation interface
+
+Functions (for backward compatibility):
+- chat(): Functional chat interface
+- translate_metrics(): Functional metrics translation interface
+"""
+
+from humex.api.ai_api.chat import Chat
+from humex.api.ai_api.translate_metrics import TranslateMetrics
+
+__all__ = ["Chat", "TranslateMetrics"]

humex-0.2.0/src/humex/api/ai_api/chat.py

@@ -0,0 +1,91 @@
+"""Chat API for humex framework interactions."""
+
+from typing import Optional
+
+from humex.api.ai_api.models._claude_cli import ClaudeCLIModel
+from humex.api.ai_api.models._qwen import QwenModel
+
+
+class Chat:
+    """Chat interface for humex-related queries.
+
+    Provides a conversational interface for asking questions and getting advice
+    about humex framework, scenarios, metrics, and analysis.
+    """
+
+    def __init__(self, model: str = "claude_cli", qwen_model: Optional[str] = None):
+        """Initialize Chat with specified model.
+
+        Args:
+            model: Model to use for chat. Supports "claude_cli" (default) or "qwen".
+            qwen_model: Ollama model name when using "qwen" (default: "qwen2.5:0.5b").
+                       Examples: "qwen2.5:0.5b", "qwen2.5:7b", "qwen2.5-coder:7b"
+
+        Raises:
+            ValueError: If an unsupported model is specified
+        """
+        if model not in ("claude_cli", "qwen"):
+            raise ValueError(
+                f"Unsupported model: {model}. Supported models: 'claude_cli', 'qwen'"
+            )
+        self.model = model
+        self._qwen_instance = QwenModel(qwen_model) if model == "qwen" else None
+
+    def send(self, message: str, context: Optional[str] = None) -> str:
+        """Send a chat message and get a response.
+
+        Args:
+            message: User's question or message
+            context: Optional context about what the user is working on
+                    (e.g., "scenario analysis", "metric configuration")
+
+        Returns:
+            Plain text response string from the selected model
+
+        Raises:
+            FileNotFoundError: If Claude CLI is not installed (when using claude_cli)
+            Exception: If the model call fails
+
+        Example:
+            >>> chat_api = Chat()
+            >>> response = chat_api.send("How do I analyze a scenario?")
+            >>> print(response)
+            # Returns helpful response about analyzing scenarios
+
+            >>> response = chat_api.send("What metrics should I track?", context="vehicle safety")
+            >>> print(response)
+            # Returns response tailored to vehicle safety metrics
+        """
+        if self.model == "claude_cli":
+            return ClaudeCLIModel.chat(message, context)
+        elif self.model == "qwen":
+            return self._qwen_instance.chat(message, context)
+        else:
+            raise ValueError(
+                f"Unsupported model: {self.model}. Supported models: 'claude_cli', 'qwen'"
+            )
+
+
+# Convenience function for backward compatibility
+def chat(
+    message: str,
+    model: str = "claude_cli",
+    context: Optional[str] = None,
+    qwen_model: Optional[str] = None
+) -> str:
+    """Convenience function for chat interactions.
+
+    This function provides backward compatibility with the functional API.
+    For new code, consider using the Chat class directly.
+
+    Args:
+        message: User's question or message
+        model: Model to use for chat (default: "claude_cli"). Supports "claude_cli" or "qwen".
+        context: Optional context about what the user is working on
+        qwen_model: Ollama model name when using "qwen" (default: "qwen2.5:0.5b")
+
+    Returns:
+        Plain text response string from the selected model
+    """
+    chat_api = Chat(model=model, qwen_model=qwen_model)
+    return chat_api.send(message, context=context)

humex-0.2.0/src/humex/api/ai_api/models/__init__.py

@@ -0,0 +1,6 @@
+"""AI model implementations."""
+
+from humex.api.ai_api.models._claude_cli import ClaudeCLIModel
+from humex.api.ai_api.models._qwen import QwenModel
+
+__all__ = ["ClaudeCLIModel", "QwenModel"]