xtc-tools 0.3.0__tar.gz

xtc_tools-0.3.0/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+# Motivation
+
+Explain motivation and/or use case for the pull request.
+
+# Description
+
+Describe functionality and overview of source changes.
+
+# Commits
+
+Describe commits if necessary or refer to change commits.
+
+# Discussion
+
+Add optional discussion and TODO below.
+
+TODO:
+- [ ] add to todo list
+

xtc_tools-0.3.0/.github/workflows/reusable-pages.yml

@@ -0,0 +1,63 @@
+name: XTC Pages
+
+on:
+  workflow_call:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+
+jobs:
+  build-pages:
+    name: Build Pages preview
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.12
+          cache: pip
+      - name: Display Python version
+        run: |
+          python -c "import sys; print(sys.version)"
+          pip list
+      - name: Install XTC Package in dev mode
+        run: |
+          pip install -e .[dev]
+      - name: Build Pages
+        run: make pages
+      - name: Upload Pages preview
+        uses: actions/upload-artifact@v5
+        with:
+          name: pages-preview
+          path: public/
+          if-no-files-found: error
+
+  deploy-pages:
+    name: Deploy Pages
+    if: startsWith(github.ref, 'refs/tags/xtc-v')
+    needs: build-pages
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Download Pages preview
+        uses: actions/download-artifact@v6
+        with:
+          name: pages-preview
+          path: public/
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: public/
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

xtc_tools-0.3.0/.github/workflows/xtc-tests.yml

@@ -0,0 +1,240 @@
+name: XTC Build and Tests
+
+# Runs on pushes targeting the main branch, pull request and manual Actions tab
+on:
+  push:
+    branches: ["main"]
+    tags: ["xtc-v*"]
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      run-tests:
+        description: Run the test matrix before building the package
+        type: boolean
+        required: true
+        default: true
+      run-pages:
+        description: Build the Pages preview
+        type: boolean
+        required: true
+        default: true
+      publish-testpypi:
+        description: Publish the package to TestPyPI
+        type: boolean
+        required: true
+        default: false
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    if: >
+      github.event_name != 'pull_request' &&
+      (github.event_name != 'workflow_dispatch' || inputs['run-tests'])
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-14, macos-15]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps: &build-steps
+      - name: Checkout XTC Repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Ensure PR has linear history
+        if: github.event_name == 'pull_request'
+        run: |
+          MERGE_COMMITS="$(git rev-list --merges "${GITHUB_SHA}"^1.."${GITHUB_SHA}"^2)"
+          if [ -n "${MERGE_COMMITS}" ]; then
+            echo "::error::PR contains merges, always use rebase for updating branches: Merge commits: ${MERGE_COMMITS}" >&2
+            exit 1
+          fi
+      - name: Install Linux Packages
+        if: runner.os == 'Linux'
+        # Note: package cache with awalsh128/cache-apt-pkgs-action does not work correctly, use standard install.
+        run: |
+          sudo apt install -y build-essential libomp5 binutils-aarch64-linux-gnu binutils-x86-64-linux-gnu libpfm4-dev
+      - name: Install macOS Packages
+        if: runner.os == 'macOs'
+        run: |
+          brew install libomp x86_64-linux-gnu-binutils aarch64-elf-binutils
+          export DYLD_LIBRARY_PATH="/opt/homebrew/opt/libomp/lib:${DYLD_LIBRARY_PATH}"
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Install XTC Package in dev mode
+        run: |
+          pip install -e .[dev]
+      - name: Dump Environment information
+        run: |
+          python -c 'import sys; print(sys.version)'
+          pip list
+          env | sort
+      - name: Run Checks
+        run: |
+          COV=scripts/coverage/coverage_run.sh
+          $COV make check
+      - name: Run Explore One Shot
+        run: |
+          COV=scripts/coverage/coverage_run.sh
+          env STRATEGIES=tile8dvr BACKENDS="tvm mlir" $COV ./scripts/explore/run-explore-one-shot.sh artifacts/explore-one-shot
+      - name: Run Explore Variants
+        run: |
+          COV=scripts/coverage/coverage_run.sh
+          env STRATEGIES=tile8dvr BACKENDS="tvm mlir" $COV ./scripts/explore/run-explore-variants.sh artifacts/explore-variants
+          env NOSHOW=1 scripts/explore/display-explore-variants.sh artifacts/explore
+      - name: Run Explore Optimizers
+        run: |
+          COV=scripts/coverage/coverage_run.sh
+          env TRIALS=20 BATCH=4 SEEDS="1 2 3" scripts/explore/run-explore-optimizers.sh artifacts/explore-optimizers
+      - name: Generate Coverage Reports
+        run: |
+          coverage combine >/dev/null
+          coverage report
+          mkdir -p artifacts/coverage
+          coverage xml -o artifacts/coverage/coverage.xml
+          coverage report --format=markdown >artifacts/coverage/coverage.md
+          coverage html -d artifacts/coverage/html
+      - name: Publish artifacts
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v5
+        with:
+          name: artifacts-os-${{ matrix.os }}
+          path: artifacts/
+      - name: Publish Coverage
+        if: matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v5
+        with:
+          files: artifacts/coverage/coverage.xml
+          flags: py${{ matrix.python-version }}-${{ matrix.os }}
+          name: py${{ matrix.python-version }}-${{ matrix.os }}
+          token: ${{ secrets.CODECOV_TOKEN }}
+          skip_validation: true
+          fail_ci_if_error: true
+
+  pr-build:
+    if: github.event_name == 'pull_request'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-15]
+        python-version: ["3.12"]
+    steps: *build-steps
+
+  build-package:
+    name: Build Python package
+    if: >
+      always() &&
+      (github.event_name == 'push' || github.event_name == 'workflow_dispatch') &&
+      (
+        needs.build.result == 'success' ||
+        (
+          github.event_name == 'workflow_dispatch' &&
+          !inputs['run-tests'] &&
+          needs.build.result == 'skipped'
+        )
+      )
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout XTC Repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+      - name: Check release tag
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          if [[ ! "${GITHUB_REF_NAME}" =~ ^xtc-v([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
+            echo "::error::Release tags must have the form xtc-vX.Y.Z"
+            exit 1
+          fi
+          git fetch origin main
+          if ! git merge-base --is-ancestor "${GITHUB_SHA}" origin/main; then
+            echo "::error::Release tag must point to a commit on main"
+            exit 1
+          fi
+      - name: Build and check package
+        env:
+          RELEASE_TAG: ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || '' }}
+        run: make wheel
+      - name: Upload package distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+
+  pages:
+    name: Build and deploy Pages
+    needs: [build, pr-build]
+    if: |
+      always() &&
+      (github.event_name != 'workflow_dispatch' || inputs['run-pages']) &&
+      (needs.build.result == 'success' || needs.build.result == 'skipped') &&
+      (needs.pr-build.result == 'success' || needs.pr-build.result == 'skipped')
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    uses: ./.github/workflows/reusable-pages.yml
+
+  publish-testpypi:
+    name: Publish development package to TestPyPI
+    if: >
+      always() &&
+      needs.build-package.result == 'success' &&
+      github.ref == 'refs/heads/main' &&
+      (
+        github.event_name == 'push' ||
+        (github.event_name == 'workflow_dispatch' && inputs['publish-testpypi'])
+      )
+    needs: build-package
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/xtc-tools
+    permissions:
+      id-token: write
+    steps:
+      - name: Download package distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-pypi:
+    name: Publish release package to PyPI
+    if: >
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/xtc-v')
+    needs: build-package
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/xtc-tools
+    permissions:
+      id-token: write
+    steps:
+      - name: Download package distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

xtc_tools-0.3.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__
+__marimo__
+*.so
+*.csv
+*.dylib
+*.a
+venv
+.venv
+build
+dist
+*egg-info*
+data
+.lit_test_times.txt
+public
+tmp.*
+save_temps_dir
+.vscode
+CLAUDE.md

xtc_tools-0.3.0/LICENSE

@@ -0,0 +1,28 @@
+BSD-3-Clause License
+
+Copyright (c) 2024-2026 The XTC Project Authors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xtc_tools-0.3.0/LICENSE_HEADER

@@ -0,0 +1,2 @@
+SPDX-License-Identifier: BSD-3-Clause
+Copyright (c) 2024-2026 The XTC Project Authors

xtc_tools-0.3.0/Makefile

@@ -0,0 +1,109 @@
+help:
+	@echo "Available make targets:"
+	@echo
+	@echo "  make test            # run minimal tests"
+	@echo "  make check           # run all acceptance tests (all targets below)"
+	@echo "    make check-format  # run all format checks tests"
+	@echo "    make check-type    # run all type checks tests"
+	@echo "    make check-dependencies # check that pyproject.toml is up to date
+	@echo "    make check-lit     # run all lit checks for binary target"
+	@echo "    make check-lit-c   # run all lit checks for C target"
+	@echo "    make check-lit-nvgpu # run all lit checks for NVGPU target"
+	@echo "    make check-pytest  # run all pytest tests"
+	@echo "    make check-banwords # run banned words checks"
+	@echo "    make check-tutorials # run tutorials checks
+	@echo "  make format          # apply formatting (warning: change files in place)"
+	@echo "    make format-license # add licenses"
+	@echo "    make format-ruff   # format python files with ruff"
+	@echo "  make dependencies    # update pyproject.toml dependencies from dependencies.toml
+	@echo "  make wheel           # install build tools, build and check distributions"
+	@echo "  make pages           # build the documentation site"
+	@echo "  make agents          # create AGENTS.md"
+	@echo "  make claude          # create CLAUDE.md"
+	@echo
+
+
+test:
+	pytest tests/pytest/unit tests/pytest/mlir tests/pytest/tvm tests/pytest/jir
+
+check: check-format check-banwords check-type check-dependencies check-lit-all check-pytest check-tutorials
+
+format: format-license format-ruff
+
+check-format: check-format-ruff check-license
+
+check-format-ruff:
+	scripts/ruff/format.sh --check
+
+check-license:
+	scripts/licensing/licensing.py --check
+
+check-banwords:
+	scripts/banwords/banwords.py --check
+
+check-type: check-pyright check-mypy
+
+check-pyright:
+	pyright
+
+check-mypy:
+	mypy
+
+check-dependencies:
+	scripts/pyproject/update_dependencies.py --check
+
+check-lit-all:
+	$(MAKE) check-lit
+	$(MAKE) check-lit-c
+
+check-lit:
+	lit -v tests/filecheck
+
+check-lit-c:
+	env XTC_MLIR_TARGET=c lit -v tests/filecheck/backends tests/filecheck/mlir_loop
+
+check-lit-nvgpu:
+	[ `uname -s` = Darwin ] || env XTC_MLIR_TARGET=nvgpu lit -v tests/filecheck/backends tests/filecheck/mlir_loop tests/filecheck/evaluation
+
+check-lit-mppa:
+	[ `uname -s` = Darwin ] || env XTC_MLIR_TARGET=mppa lit -v -j 1 tests/filecheck/backends/target_mppa tests/filecheck/evaluation/test_matmul_pmu_counters_mppa.py
+
+check-pytest:
+	scripts/pytest/run_pytest.sh -v
+
+check-tutorials:
+	scripts/tutorials/test_marimos.sh
+	scripts/tutorials/test_tutorial_explore_optimizers.sh
+	scripts/tutorials/test_tutorial_xtc_101.sh
+
+format-ruff:
+	scripts/ruff/format.sh
+
+format-license:
+	scripts/licensing/licensing.py --apply
+
+dependencies:
+	scripts/pyproject/update_dependencies.py
+
+wheel:
+	python -m ensurepip --upgrade
+	python -m pip install --upgrade build twine
+	rm -rf build dist src/*.egg-info
+	python -m build
+	python -m twine check dist/*
+	python scripts/pyproject/check_wheel.py
+
+pages:
+	$(MAKE) -C docs/site site
+
+agents:
+	scripts/llms/init_agents.py agents README.md "Links" "AI assistants" > AGENTS.md
+
+claude:
+	scripts/llms/init_agents.py claude README.md "Links" "AI assistants" > CLAUDE.md
+
+run-tutorial:
+	marimo run docs/tutorials/xtc_101.py
+
+.PHONY: help test check check-lit-all check-lit check-lit-c check-lit-nvpgu check-pytest check-type check-pyright check-mypy check-format check-format-ruff check-license check-banwords format format-ruff format-license agents claude check-tutorials run-tutorial check-dependencies dependencies wheel pages
+.SUFFIXES: