ernie-renderer 0.1.0.dev189__tar.gz

ernie_renderer-0.1.0.dev189/.clang-format

@@ -0,0 +1,11 @@
+BasedOnStyle: LLVM
+IndentWidth: 4
+ColumnLimit: 100
+PointerAlignment: Left
+ReferenceAlignment: Left
+BreakBeforeBraces: Attach
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: Never
+SortIncludes: CaseSensitive
+IncludeBlocks: Preserve
+SpacesBeforeTrailingComments: 2

ernie_renderer-0.1.0.dev189/.clang-tidy

@@ -0,0 +1,18 @@
+---
+Checks: >
+  -*,
+  bugprone-*,
+  performance-*,
+  portability-*,
+  clang-analyzer-*,
+  modernize-use-nullptr,
+  modernize-use-override,
+  modernize-use-equals-default,
+  modernize-use-equals-delete,
+  readability-else-after-return,
+  readability-redundant-*,
+  -bugprone-easily-swappable-parameters
+
+WarningsAsErrors: ''
+HeaderFilterRegex: '.*/ernie/[a-z_]+/[^/]+\\.h$'
+FormatStyle: file

ernie_renderer-0.1.0.dev189/.cmake-format.yaml

@@ -0,0 +1,11 @@
+format:
+  line_width: 100
+  tab_size: 4
+  max_subgroups_hwrap: 2
+  max_pargs_hwrap: 6
+  separate_ctrl_name_with_space: false
+  separate_fn_name_with_space: false
+  dangle_parens: false
+
+markup:
+  enable_markup: false

ernie_renderer-0.1.0.dev189/.gitattributes

@@ -0,0 +1,23 @@
+# Normalize line endings for text files
+* text=auto eol=lf
+
+# Binary assets (images, rasters, meshes, fonts) are stored in Git LFS wherever they are
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.exr filter=lfs diff=lfs merge=lfs -text
+*.hdr filter=lfs diff=lfs merge=lfs -text
+*.ktx2 filter=lfs diff=lfs merge=lfs -text
+*.tif filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+*.gpkg filter=lfs diff=lfs merge=lfs -text
+*.glb filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.obj filter=lfs diff=lfs merge=lfs -text
+*.ply filter=lfs diff=lfs merge=lfs -text
+*.stl filter=lfs diff=lfs merge=lfs -text
+*.ttf filter=lfs diff=lfs merge=lfs -text
+*.otf filter=lfs diff=lfs merge=lfs -text
+
+# Except the tests' small fixtures, kept in git itself so checkouts and CI need no LFS
+ernie/test/fixtures/** -filter -diff -merge -text

ernie_renderer-0.1.0.dev189/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+name: Bug report
+description: Something renders wrongly, crashes, or doesn't build.
+labels: [bug]
+body:
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened
+      description: What you saw, and what you expected instead. Screenshots help with rendering bugs.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: How to reproduce
+      description: The smallest scene or script that shows it (Python or C++), or the commands for a build failure.
+      render: python
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Ernie version
+      description: "`ernie --version`, `python -c 'import importlib.metadata as m; print(m.version(\"ernie\"))'`, or the commit"
+    validations:
+      required: true
+  - type: dropdown
+    id: install
+    attributes:
+      label: Installed from
+      options:
+        - pip
+        - DEB / RPM / TGZ package
+        - Built from source
+        - Docker image
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: Ubuntu 24.04
+    validations:
+      required: true
+  - type: input
+    id: gpu
+    attributes:
+      label: GPU and driver
+      description: "`vulkaninfo --summary` shows both; lavapipe counts too."
+      placeholder: NVIDIA RTX 4080, driver 580.65
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Log output
+      description: Errors, stack traces, or Vulkan validation messages.
+      render: text

ernie_renderer-0.1.0.dev189/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,21 @@
+name: Feature request
+description: A sensor, effect, prim type or API Ernie should have.
+labels: [enhancement]
+body:
+  - type: textarea
+    id: need
+    attributes:
+      label: What you're trying to do
+      description: The simulation or workflow, and what's missing today.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: What you'd like
+      description: How it could look in the scene or API. For physical models, link the papers or instrument specs.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Workarounds you've tried, or how other renderers do it.

ernie_renderer-0.1.0.dev189/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  # The actions the workflows use: new major versions only, grouped into one pull request a month.
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      actions:
+        patterns: ["*"]
+        update-types: ["major"]
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-minor", "version-update:semver-patch"]

ernie_renderer-0.1.0.dev189/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## What and why
+
+<!-- What this changes, and the problem it solves. Link the issue if there is one. -->
+
+## Testing
+
+<!-- The tests you added or ran: unit, gpu (on which GPU, or lavapipe), python, install. For rendering changes, before/after images help. -->
+
+- [ ] `pre-commit run --all-files` passes
+- [ ] New behavior has tests
+- [ ] Public API has `///` doc comments (with references for published techniques)

ernie_renderer-0.1.0.dev189/.github/scripts/ci_metrics.py

@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: BSD-3-Clause
+"""One CI run's metrics for github-action-benchmark (customSmallerIsBetter): the run's wall time,
+each successful job's time and its build and test steps' from the Actions API, and from the jobs'
+Ninja logs their compile time, compile count and ccache miss rate.
+
+    GH_TOKEN=... GITHUB_REPOSITORY=owner/repo python ci_metrics.py RUN_ID LOG_DIR OUTPUT
+
+LOG_DIR holds one directory per job's artifact (ninja-log-<job>), each with the build's .ninja_log
+and, where the job uses ccache, ccache-stats.tsv (`ccache --print-stats`).
+"""
+
+import json
+import os
+import sys
+import urllib.request
+from datetime import datetime
+from pathlib import Path
+
+# The steps whose times are worth tracking on their own: building, testing, wheels and packages.
+STEPS = ("Build", "Test on lavapipe", "Build the packages", "Run pypa/cibuildwheel")
+
+
+def api(path):
+    request = urllib.request.Request(
+        f"https://api.github.com/repos/{os.environ['GITHUB_REPOSITORY']}/{path}",
+        headers={
+            "Authorization": f"Bearer {os.environ['GH_TOKEN']}",
+            "Accept": "application/vnd.github+json",
+        },
+    )
+    with urllib.request.urlopen(request) as response:
+        return json.load(response)
+
+
+def seconds(start, end):
+    parse = lambda stamp: datetime.fromisoformat(stamp.replace("Z", "+00:00"))  # noqa: E731
+    return (parse(end) - parse(start)).total_seconds()
+
+
+def metric(name, unit, value):
+    return {"name": name, "unit": unit, "value": round(value, 2)}
+
+
+def run_metrics(run_id):
+    run = api(f"actions/runs/{run_id}")
+    metrics = [metric("CI: wall time", "min", seconds(run["run_started_at"], run["updated_at"]) / 60)]
+    jobs = api(f"actions/runs/{run_id}/jobs?per_page=100")["jobs"]
+    for job in jobs:
+        if job["conclusion"] != "success" or not job["completed_at"]:
+            continue
+        name = job["name"]
+        metrics.append(metric(f"{name}: job", "min", seconds(job["started_at"], job["completed_at"]) / 60))
+        for step in job.get("steps", []):
+            if step["conclusion"] == "success" and step["name"].startswith(STEPS):
+                label = "wheel build" if step["name"].startswith("Run pypa/cibuildwheel") else step["name"]
+                duration = seconds(step["started_at"], step["completed_at"]) / 60
+                metrics.append(metric(f"{name}: {label}", "min", duration))
+    return metrics
+
+
+def ninja_metrics(job, log):
+    """Compile time and count from a .ninja_log: a "# ninja log vN" header, then a line per
+    output (start and end in ms, mtime, output, hash), the last of an output rebuilt counting."""
+    outputs = {}
+    for line in log.read_text().splitlines():
+        fields = line.split("\t")
+        if line.startswith("#") or len(fields) < 4:
+            continue
+        outputs[fields[3]] = int(fields[1]) - int(fields[0])
+    compiles = [ms for output, ms in outputs.items() if output.endswith((".o", ".obj"))]
+    if not compiles:
+        return []
+    return [
+        metric(f"{job}: compile time", "min", sum(compiles) / 60000),
+        metric(f"{job}: compiles", "files", len(compiles)),
+    ]
+
+
+def ccache_metrics(job, stats):
+    """The compiler cache's miss rate, from `ccache --print-stats` (key, tab, value per line)."""
+    values = dict(line.split("\t", 1) for line in stats.read_text().splitlines() if "\t" in line)
+    hits = int(values.get("direct_cache_hit", 0)) + int(values.get("preprocessed_cache_hit", 0))
+    misses = int(values.get("cache_miss", 0))
+    if hits + misses == 0:
+        return []
+    return [metric(f"{job}: ccache miss rate", "%", 100 * misses / (hits + misses))]
+
+
+def main():
+    run_id, log_dir, output = sys.argv[1], Path(sys.argv[2]), Path(sys.argv[3])
+    metrics = run_metrics(run_id)
+    for artifact in sorted(log_dir.glob("ninja-log-*")):
+        job = artifact.name.removeprefix("ninja-log-")
+        if (artifact / ".ninja_log").exists():
+            metrics += ninja_metrics(job, artifact / ".ninja_log")
+        if (artifact / "ccache-stats.tsv").exists():
+            metrics += ccache_metrics(job, artifact / "ccache-stats.tsv")
+    output.write_text(json.dumps(metrics, indent=2))
+    print(f"{len(metrics)} metrics written to {output}")
+
+
+if __name__ == "__main__":
+    main()

ernie_renderer-0.1.0.dev189/.github/workflows/ci-metrics.yml

@@ -0,0 +1,46 @@
+# Each CI run on main, recorded: its wall time, its jobs' and their build and test steps' times, and
+# from the Ninja logs the compile time, compile count and ccache miss rate, kept on gh-pages under
+# dev/ci with charts (https://alexmaietta.github.io/ernie/dev/ci/). A metric 30% worse than the last
+# run's gets a commit comment.
+name: CI metrics
+
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+    branches: [main]
+
+permissions:
+  contents: write
+  actions: read
+
+jobs:
+  record:
+    if: github.event.workflow_run.event == 'push'
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/download-artifact@v8
+        with:
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pattern: ninja-log-*
+          path: ninja-logs
+      - name: Collect the metrics
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: python3 .github/scripts/ci_metrics.py "${{ github.event.workflow_run.id }}" ninja-logs metrics.json
+      - uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: CI
+          tool: customSmallerIsBetter
+          output-file-path: metrics.json
+          gh-pages-branch: gh-pages
+          benchmark-data-dir-path: dev/ci
+          ref: ${{ github.event.workflow_run.head_sha }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          alert-threshold: "130%"
+          comment-on-alert: true
+          fail-on-alert: false
+          max-items-in-chart: 200