diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bec6056..a1f18dd 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,10 +13,44 @@ concurrency: group: ci-${{ github.ref }} cancel-in-progress: true +permissions: + contents: read + env: CARGO_TERM_COLOR: always jobs: + lint-python: + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + - uses: astral-sh/setup-uv@v10.0.0 + - name: Ruff + run: | + uvx ruff check + uvx ruff format --check + + licenses: + # The license texts shipped in wheels must match Cargo.lock. + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + - uses: taiki-e/install-action@v2 + with: + tool: cargo-about@0.9.3 + - name: Regenerate licenses/THIRD_PARTY_RUST.txt + run: cargo about generate --locked -m crates/motion_py/Cargo.toml about.hbs -o licenses/THIRD_PARTY_RUST.txt + - name: Compare with the committed file + run: | + git diff --exit-code licenses/THIRD_PARTY_RUST.txt || { + echo "::error::licenses/THIRD_PARTY_RUST.txt is out of date: run the command in about.toml and commit the result" + exit 1 + } + test: name: test (${{ matrix.os }}) runs-on: ${{ matrix.os }} diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..1111ad3 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,24 @@ +name: docs + +# Builds the documentation on pull requests (strict: warnings fail). Releases deploy it, +# see release.yml. + +on: + pull_request: + push: + branches: [main] + +concurrency: + group: docs-${{ github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: compas-dev/compas-actions/docs@v1 + with: + extras: docs diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml new file mode 100644 index 0000000..1b3590c --- /dev/null +++ b/.github/workflows/pr-checks.yml @@ -0,0 +1,26 @@ +name: pr-checks + +on: + pull_request: + types: [assigned, opened, synchronize, reopened, labeled, unlabeled] + branches: + - main + +permissions: + contents: read + +jobs: + release: + name: Validate release metadata + runs-on: ubuntu-latest + steps: + - uses: compas-dev/compas-actions/release-check@v1 + + changelog: + name: Check changelog + runs-on: ubuntu-latest + steps: + - uses: compas-dev/compas-actions/pr-checks@v1 + with: + changelog-path: CHANGELOG.md + skip-label: no changelog diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml new file mode 100644 index 0000000..4abffe6 --- /dev/null +++ b/.github/workflows/prepare-release.yml @@ -0,0 +1,29 @@ +name: prepare release + +# Opens a release pull request: bumps the version (pyproject.toml [tool.bumpversion] lists +# the files) and dates the changelog. Merging it runs release.yml. + +on: + workflow_dispatch: + inputs: + release-type: + description: Semantic version component to bump + required: true + type: choice + options: + - patch + - minor + - major + +permissions: + contents: write + pull-requests: write + +jobs: + release-pr: + runs-on: ubuntu-latest + steps: + - uses: compas-dev/compas-actions/release-pr@v1 + with: + release-type: ${{ inputs.release-type }} + github-token: ${{ github.token }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..02da9c2 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,107 @@ +name: release + +# Runs on every push to main and does nothing unless the push is a merged release pull +# request (see prepare-release.yml): then it builds and tests the wheels and the source +# distribution, publishes them to PyPI, creates the GitHub release and deploys the docs. + +on: + push: + branches: [main] + +permissions: + contents: read + +jobs: + release: + name: Detect release merge + runs-on: ubuntu-latest + outputs: + is-release: ${{ steps.release.outputs.is-release }} + version: ${{ steps.release.outputs.version }} + tag: ${{ steps.release.outputs.tag }} + steps: + - uses: compas-dev/compas-actions/release-check@v1 + id: release + + wheels: + needs: release + if: needs.release.outputs.is-release == 'true' + uses: ./.github/workflows/wheels.yml + + collect: + name: Collect distributions + needs: [release, wheels] + if: needs.release.outputs.is-release == 'true' + runs-on: ubuntu-latest + steps: + - uses: actions/download-artifact@v5 + with: + pattern: wheel-* + path: dist + merge-multiple: true + - uses: actions/download-artifact@v5 + with: + name: sdist + path: dist + - name: Check versions and metadata + env: + VERSION: ${{ needs.release.outputs.version }} + run: | + ls -l dist + for f in dist/*; do + case "$(basename "$f")" in + compas_fab_native-"$VERSION"-*.whl|compas_fab_native-"$VERSION".tar.gz) ;; + *) echo "::error::$f is not version $VERSION"; exit 1 ;; + esac + done + test "$(ls dist/*.whl | wc -l)" -eq 3 + pipx run twine check --strict dist/* + - uses: actions/upload-artifact@v5 + with: + name: python-package-distributions + path: dist/ + + publish: + needs: [release, collect] + if: needs.release.outputs.is-release == 'true' + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/p/compas_fab_native + permissions: + contents: read + id-token: write + steps: + - uses: actions/download-artifact@v5 + with: + name: python-package-distributions + path: dist + - name: Publish to PyPI (trusted publishing) + uses: pypa/gh-action-pypi-publish@v1.14.2 + + create-release: + needs: [release, publish] + if: needs.release.outputs.is-release == 'true' + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: compas-dev/compas-actions/github-release@v1 + with: + github-token: ${{ github.token }} + tag-name: ${{ needs.release.outputs.tag }} + target: ${{ github.sha }} + release-name-prefix: COMPAS FAB Native + + docs: + needs: [release, create-release] + if: needs.release.outputs.is-release == 'true' + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: compas-dev/compas-actions/docs@v1 + with: + deploy: true + version: ${{ needs.release.outputs.version }} + extras: docs diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml index 207482a..227a272 100644 --- a/.github/workflows/wheels.yml +++ b/.github/workflows/wheels.yml @@ -1,20 +1,28 @@ name: wheels -# Builds the compas_fab_native extension as release wheels (abi3: one wheel per platform -# for every Python >= 3.9) and tests each wheel on the oldest and newest Python we support. -# Python 3.9 is what Rhino 8 ships. Nothing is published: the wheels are uploaded as -# artifacts (native-wheel-). +# Builds the compas_fab_native extension as wheels (abi3: one wheel per platform for every +# Python >= 3.9) and a source distribution, and tests each wheel on the oldest and newest +# Python we support (3.9 is what Rhino 8 ships) and the source distribution built from +# scratch. Artifacts: wheel-, sdist. +# +# release.yml calls this workflow to build what it publishes. on: push: branches: [main] pull_request: workflow_dispatch: + workflow_call: concurrency: - group: wheels-${{ github.ref }} + # github.workflow is the caller's name when called, so a release never cancels (or is + # cancelled by) the regular run on the same commit. + group: ${{ github.workflow }}-wheels-${{ github.ref }} cancel-in-progress: true +permissions: + contents: read + jobs: build: name: build (${{ matrix.platform }}) @@ -37,6 +45,8 @@ jobs: manylinux: "" steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - name: Build the wheel uses: PyO3/maturin-action@v1 with: @@ -45,9 +55,25 @@ jobs: args: --release --out dist - uses: actions/upload-artifact@v5 with: - name: native-wheel-${{ matrix.platform }} + name: wheel-${{ matrix.platform }} path: dist/*.whl + sdist: + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + - name: Build the source distribution + uses: PyO3/maturin-action@v1 + with: + command: sdist + args: --out dist + - uses: actions/upload-artifact@v5 + with: + name: sdist + path: dist/*.tar.gz + test: name: test (${{ matrix.platform }}, py${{ matrix.python }}) needs: build @@ -66,18 +92,44 @@ jobs: os: windows-2022 steps: - uses: actions/checkout@v6 + with: + persist-credentials: false - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python }} - uses: actions/download-artifact@v5 with: - name: native-wheel-${{ matrix.platform }} + name: wheel-${{ matrix.platform }} path: dist - name: Install the wheel shell: bash run: | python -m pip install --upgrade pip python -m pip install dist/*.whl pytest - python -c "import compas_fab_native, sys; print(sys.version, compas_fab_native.__file__)" - - name: Native tests on the installed wheel - run: python -m pytest tests -q + python -c "import compas_fab_native, sys; print(sys.version, compas_fab_native.__version__, compas_fab_native.__file__)" + - name: Tests on the installed wheel + # Not from the checkout's src/: the tests must import the installed wheel. + run: python -m pytest tests -q -p no:cacheprovider + + test-sdist: + name: test (sdist, py3.12) + needs: sdist + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v6 + with: + persist-credentials: false + - uses: actions/setup-python@v5 + with: + python-version: "3.12" + - uses: actions/download-artifact@v5 + with: + name: sdist + path: dist + - name: Build and install from the source distribution + shell: bash + run: | + python -m pip install --upgrade pip + python -m pip install dist/*.tar.gz pytest + - name: Tests on the installed package + run: python -m pytest tests -q -p no:cacheprovider diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..88af881 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Added + +* `NativePlanner` and `NativeClient`: a compas_fab planning backend on a compiled (Rust) core, moved here from the `compas_fab` spike branch with its history. +* Forward kinematics, and inverse kinematics for frame and point-axis targets: closed form for UR arms and spherical-wrist arms (derived from the robot model), numerical and collision-aware for any other serial robot. +* `check_collision` on the sphere model or on the exact meshes, including tools and workpieces the robot carries. +* `plan_cartesian_motion` for frame and point-axis waypoints in robot, tool and workpiece mode, with free rotation about the tool axis. +* `plan_motion` to configuration, frame and point-axis targets, timed under joint velocity and acceleration limits. +* Mesh obstacles as signed distance fields (`NativePlanner(obstacles="esdf")`), which keep holes and concave shapes open. +* Release workflow on `compas-dev/compas-actions`: wheels for Linux (x86_64), macOS (universal2) and Windows (x64), each tested on Python 3.9 and 3.13, a source distribution, and publishing to PyPI. +* License texts of the Rust crates compiled into the extension, in `licenses/THIRD_PARTY_RUST.txt`. +* Documentation site. + +### Changed + +* Collision spheres are fitted in the core instead of in Python with trimesh: about 20 times faster (0.08 s instead of 1.7 s to set up a UR5), and trimesh and rtree are no longer dependencies. + +### Removed diff --git a/Cargo.lock b/Cargo.lock index aa9336d..004433e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -539,7 +539,7 @@ dependencies = [ [[package]] name = "motion_py" -version = "0.1.0-dev0" +version = "0.0.0" dependencies = [ "motion_core", "motion_exact", diff --git a/NOTICE b/NOTICE index e155938..6e3804e 100644 --- a/NOTICE +++ b/NOTICE @@ -101,6 +101,6 @@ follow the third-party works listed below. Their licenses are in `licenses/`. differentiates JAX code automatically, numik.rs writes the Jacobians out). -Rust crates and Python packages used as dependencies keep their own licenses; see -`Cargo.lock` (`cargo metadata`) and `pyproject.toml`. Wheels built for distribution must -bundle their license texts (to do before the first release, e.g. with cargo-about). +Rust crates compiled into the Python extension keep their own licenses; their texts are in +`licenses/THIRD_PARTY_RUST.txt` (generated with cargo-about, see `about.toml`), which wheels +ship. Python packages installed as dependencies (`pyproject.toml`) keep theirs. diff --git a/README.md b/README.md index 3d8cf8f..b45054d 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,21 @@ A planning backend for [compas_fab](https://github.com/compas-dev/compas_fab) whose work happens in a compiled Rust core inside the Python process: no Docker, no PyBullet, no ROS. -It is an early spike. The API is the usual compas_fab backend API, but what it supports is -limited and may change. See the [overview](docs/index.md) for what it does and its -trade-offs, [how it works](docs/how-it-works.md) for the internals, and -[`SPIKE.md`](SPIKE.md) for the measurements and open issues. +It is experimental. The API is the usual compas_fab backend API, but what it supports is +limited and may change. The [documentation](https://compas.dev/compas_fab_native) covers +what it does, its trade-offs and how it works; [`SPIKE.md`](SPIKE.md) has the design notes, +measurements and open issues. ## Install -Not on PyPI yet. From a checkout of this repository, with a -[Rust toolchain](https://rustup.rs) installed: - ```bash -pip install . +pip install compas_fab_native ``` +Wheels are available for Linux (x86_64), macOS (Intel and Apple Silicon) and Windows (x64), +for Python 3.9 and later. Elsewhere, pip builds from source, which needs a +[Rust toolchain](https://rustup.rs). + ## Use ```python @@ -32,7 +33,7 @@ More examples are in [`docs/files/`](docs/files). | Path | Contents | |---|---| -| `crates/` | Rust workspace: the core (`motion_core`), exact checks (`motion_exact`), GPU kernels (`motion_gpu`), benchmarks (`motion_bench`) and Python bindings (`motion_py`) | +| `crates/` | Rust workspace: the core (`motion_core`), exact checks and sphere fitting (`motion_exact`), GPU kernels (`motion_gpu`), benchmarks (`motion_bench`) and Python bindings (`motion_py`) | | `src/compas_fab_native/` | The compas_fab backend: `NativePlanner` and the robot model translation | | `tests/` | Python tests of the backend; the Rust tests live in each crate | | `docs/` | Documentation, examples and diagrams | @@ -41,14 +42,27 @@ More examples are in [`docs/files/`](docs/files). ## Development +With a [Rust toolchain](https://rustup.rs) installed: + ```bash -pip install maturin pytest -maturin develop --release # builds the extension in place -python -m pytest tests +pip install -e ".[dev]" # builds the extension; rerun after changing Rust code +python -m pytest cargo test --workspace --exclude motion_py --release +ruff check && ruff format --check ``` +Documentation: `pip install -e ".[docs]"`, then `mkdocs serve`. + +## Releasing + +1. Run the **prepare release** workflow (Actions tab) with the kind of bump. It opens a + release pull request that bumps the version and dates the changelog. +2. Review and merge it. The **release** workflow then builds and tests the wheels and the + source distribution, publishes them to PyPI, creates the GitHub release and deploys the + documentation. + ## License MIT, see [`LICENSE`](LICENSE). Third-party code, data and algorithms used here are credited -in [`NOTICE`](NOTICE), with their licenses in [`licenses/`](licenses). +in [`NOTICE`](NOTICE), with their licenses in [`licenses/`](licenses), including those of +the Rust crates compiled into the extension. diff --git a/about.hbs b/about.hbs new file mode 100644 index 0000000..4aa8c6c --- /dev/null +++ b/about.hbs @@ -0,0 +1,25 @@ +Third-party Rust crates compiled into compas_fab_native +======================================================= + +The compiled extension (compas_fab_native/_core) contains code from the Rust crates below. +Their licenses follow, each with the crates it applies to. Generated by cargo-about from +about.toml and about.hbs; do not edit by hand. + +Overview +-------- +{{#each overview}} +{{name}}: {{count}} crate(s) +{{/each}} + +{{#each licenses}} +-------------------------------------------------------------------------------- +{{name}} + +Used by: +{{#each used_by}} + {{crate.name}} {{crate.version}}{{#if crate.repository}} ({{crate.repository}}){{/if}} +{{/each}} + +{{text}} + +{{/each}} diff --git a/about.toml b/about.toml new file mode 100644 index 0000000..b4babb3 --- /dev/null +++ b/about.toml @@ -0,0 +1,28 @@ +# cargo-about: license texts of the Rust crates compiled into the Python extension. +# +# cargo about generate --locked -m crates/motion_py/Cargo.toml about.hbs -o licenses/THIRD_PARTY_RUST.txt +# +# CI regenerates the file and fails if it differs from the committed one. + +# In order of preference, for crates that offer a choice. +accepted = [ + "MIT", + "Apache-2.0", + "BSD-2-Clause", + "BSD-3-Clause", + "ISC", + "Unicode-3.0", + "Unlicense", + "Zlib", +] +# The platforms wheels are built for. +targets = [ + "x86_64-unknown-linux-gnu", + "x86_64-apple-darwin", + "aarch64-apple-darwin", + "x86_64-pc-windows-msvc", +] +# Only what ends up in the wheel: no build tools, no test dependencies, not our own crates. +ignore-build-dependencies = true +ignore-dev-dependencies = true +private = { ignore = true } diff --git a/crates/motion_py/Cargo.toml b/crates/motion_py/Cargo.toml index 8a86296..2be0da8 100644 --- a/crates/motion_py/Cargo.toml +++ b/crates/motion_py/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "motion_py" -version = "0.1.0-dev0" +version = "0.0.0" edition.workspace = true license.workspace = true publish.workspace = true diff --git a/crates/motion_py/src/lib.rs b/crates/motion_py/src/lib.rs index 983af57..dc3f1d1 100644 --- a/crates/motion_py/src/lib.rs +++ b/crates/motion_py/src/lib.rs @@ -1,4 +1,4 @@ -//! Python bindings for the native motion core (spike). +//! Python bindings for the native motion core. //! //! A thin layer: the robot model and scene come in as JSON (built on the Python side from //! a compas_fab RobotCell, see `compas_fab_native`), queries run in Rust with the diff --git a/demo/live_viewer/README.md b/demo/live_viewer/README.md index 5279a12..416697c 100644 --- a/demo/live_viewer/README.md +++ b/demo/live_viewer/README.md @@ -92,7 +92,7 @@ Aymeric Augustin and contributors). The robot meshes come from compas_fab's robot library: - **UR5:** Universal Robots' `ur_description` (ROS-Industrial), BSD-3-Clause; see - `src/compas_fab/data/robot_library/ur_description/LICENSE`. + `src/compas_fab/data/robot_library/ur_description/LICENSE` in compas_fab. - **Panda:** Franka Emika's `franka_description` (franka_ros), Apache-2.0. - **RFL:** the RFL description (hall, rails, bridges, carriages) of Gramazio Kohler Research, ETH Zurich, as shipped in compas_fab's robot library (`robot_library/rfl`, diff --git a/demo/live_viewer/scenarios.py b/demo/live_viewer/scenarios.py index 352825a..265cdae 100644 --- a/demo/live_viewer/scenarios.py +++ b/demo/live_viewer/scenarios.py @@ -3,10 +3,22 @@ import time +import compas_fab import numpy as np from compas.geometry import Box from compas.geometry import Frame from compas.geometry import Torus +from compas_fab.backends import UR5Kinematics +from compas_fab.backends.exceptions import BackendError +from compas_fab.backends.kinematics.exceptions import CartesianMotionError +from compas_fab.robots import ConfigurationTarget +from compas_fab.robots import FrameTarget +from compas_fab.robots import FrameWaypoints +from compas_fab.robots import PointAxisTarget +from compas_fab.robots import RigidBody +from compas_fab.robots import RigidBodyState +from compas_fab.robots import RobotCellLibrary +from compas_fab.robots import TargetMode from kin import Arm from scene import compas_mesh_tris from scene import frame_from_matrix @@ -19,19 +31,7 @@ from scene import target_marker_tris from scipy.spatial.transform import Rotation -import compas_fab -from compas_fab.backends import UR5Kinematics -from compas_fab.backends.exceptions import BackendError -from compas_fab.backends.kinematics.exceptions import CartesianMotionError from compas_fab_native import NativePlanner -from compas_fab.robots import ConfigurationTarget -from compas_fab.robots import FrameTarget -from compas_fab.robots import FrameWaypoints -from compas_fab.robots import PointAxisTarget -from compas_fab.robots import RigidBody -from compas_fab.robots import RigidBodyState -from compas_fab.robots import RobotCellLibrary -from compas_fab.robots import TargetMode DT = 1 / 60 ACCENT = "#f2b705" diff --git a/docs/_logo/compas_logo_white_transparent.png b/docs/_logo/compas_logo_white_transparent.png new file mode 100644 index 0000000..5dd158c Binary files /dev/null and b/docs/_logo/compas_logo_white_transparent.png differ diff --git a/docs/_logo/favicon.ico b/docs/_logo/favicon.ico new file mode 100644 index 0000000..381bd94 Binary files /dev/null and b/docs/_logo/favicon.ico differ diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..40052e4 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,11 @@ +# API reference + +`compas_fab_native` is a compas_fab backend: you use it through the regular compas_fab +planner API (`set_robot_cell`, `inverse_kinematics`, `check_collision`, +`plan_cartesian_motion`, `plan_motion`, ...). The pages of compas_fab document those calls; +this page covers what is specific to the native backend: its constructor options and the +planner options it understands. + +::: compas_fab_native.NativePlanner + +::: compas_fab_native.NativeClient diff --git a/docs/assets/stylesheets/custom.css b/docs/assets/stylesheets/custom.css new file mode 100644 index 0000000..d341f69 --- /dev/null +++ b/docs/assets/stylesheets/custom.css @@ -0,0 +1,5 @@ +:root>* { + --md-primary-fg-color: #0092d2; + --md-primary-fg-color--light: #0092d2; + --md-primary-fg-color--dark: #0092d2; +} \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..786b75d --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +--8<-- "CHANGELOG.md" diff --git a/docs/files/01_kinematics.py b/docs/files/01_kinematics.py index 23c3329..9189960 100644 --- a/docs/files/01_kinematics.py +++ b/docs/files/01_kinematics.py @@ -10,13 +10,13 @@ import time from compas.geometry import Frame - from compas_fab.backends import UR5Kinematics -from compas_fab_native import NativePlanner from compas_fab.robots import FrameTarget from compas_fab.robots import RobotCellLibrary from compas_fab.robots import TargetMode +from compas_fab_native import NativePlanner + # 1. A robot cell: a UR5 on its own. `state` holds everything that moves: the robot's joint # values, its base frame, tools and obstacles. robot_cell, state = RobotCellLibrary.ur5() diff --git a/docs/files/02_collision_checking.py b/docs/files/02_collision_checking.py index fd3089f..49cce31 100644 --- a/docs/files/02_collision_checking.py +++ b/docs/files/02_collision_checking.py @@ -11,14 +11,14 @@ from compas.geometry import Box from compas.geometry import Frame - from compas_fab.backends import CollisionCheckError from compas_fab.backends import UR5Kinematics -from compas_fab_native import NativePlanner from compas_fab.robots import RigidBody from compas_fab.robots import RigidBodyState from compas_fab.robots import RobotCellLibrary +from compas_fab_native import NativePlanner + # 1. A UR5 next to a table-sized box. robot_cell, state = RobotCellLibrary.ur5() robot_cell.rigid_body_models["table"] = RigidBody.from_mesh(Box(0.6, 0.6, 0.3).to_mesh(triangulated=True)) diff --git a/docs/files/03_cartesian_line.py b/docs/files/03_cartesian_line.py index 4dff7bd..0429c03 100644 --- a/docs/files/03_cartesian_line.py +++ b/docs/files/03_cartesian_line.py @@ -9,13 +9,13 @@ import time from compas.geometry import Frame - from compas_fab.backends import UR5Kinematics -from compas_fab_native import NativePlanner from compas_fab.robots import FrameWaypoints from compas_fab.robots import RobotCellLibrary from compas_fab.robots import TargetMode +from compas_fab_native import NativePlanner + robot_cell, state = RobotCellLibrary.ur5() planner = NativePlanner(UR5Kinematics()) planner.set_robot_cell(robot_cell, state) diff --git a/docs/files/04_tool_and_free_axis.py b/docs/files/04_tool_and_free_axis.py index 29a2237..21f4e7f 100644 --- a/docs/files/04_tool_and_free_axis.py +++ b/docs/files/04_tool_and_free_axis.py @@ -10,14 +10,14 @@ import time from compas.geometry import Frame - from compas_fab.backends import UR5Kinematics from compas_fab.backends.kinematics.exceptions import CartesianMotionError -from compas_fab_native import NativePlanner from compas_fab.robots import FrameWaypoints from compas_fab.robots import RobotCellLibrary from compas_fab.robots import TargetMode +from compas_fab_native import NativePlanner + # 1. A UR5 with a cone-shaped tool. The tool is part of the collision model. robot_cell, state = RobotCellLibrary.ur5_cone_tool() planner = NativePlanner(UR5Kinematics()) diff --git a/docs/files/05_mesh_obstacles.py b/docs/files/05_mesh_obstacles.py index b6a093e..11f56c8 100644 --- a/docs/files/05_mesh_obstacles.py +++ b/docs/files/05_mesh_obstacles.py @@ -11,16 +11,16 @@ from compas.geometry import Frame from compas.geometry import Torus - from compas_fab.backends import UR5Kinematics from compas_fab.backends.kinematics.exceptions import CartesianMotionError -from compas_fab_native import NativePlanner from compas_fab.robots import FrameWaypoints from compas_fab.robots import RigidBody from compas_fab.robots import RigidBodyState from compas_fab.robots import RobotCellLibrary from compas_fab.robots import TargetMode +from compas_fab_native import NativePlanner + # 1. A ring (50 cm across, tube 5 cm thick) lying flat in front of the robot. (Much # narrower and the UR5's wrist only just fits: whether it passes then depends on details # of the sphere fit.) diff --git a/docs/files/06_free_motion.py b/docs/files/06_free_motion.py index b652b9b..ed6f26d 100644 --- a/docs/files/06_free_motion.py +++ b/docs/files/06_free_motion.py @@ -12,9 +12,7 @@ from compas.geometry import Frame from compas.geometry import Point from compas.geometry import Vector - from compas_fab.backends import UR5Kinematics -from compas_fab_native import NativePlanner from compas_fab.robots import ConfigurationTarget from compas_fab.robots import FrameTarget from compas_fab.robots import PointAxisTarget @@ -23,6 +21,8 @@ from compas_fab.robots import RobotCellLibrary from compas_fab.robots import TargetMode +from compas_fab_native import NativePlanner + # 1. A UR5 with a wall in front of it. robot_cell, _ = RobotCellLibrary.ur5() robot_cell.rigid_body_models["wall"] = RigidBody.from_mesh(Box(0.05, 0.8, 0.8).to_mesh(triangulated=True)) diff --git a/docs/how-it-works.md b/docs/how-it-works.md index 27143f7..8afdbd4 100644 --- a/docs/how-it-works.md +++ b/docs/how-it-works.md @@ -227,5 +227,5 @@ accepts them, and they differ from the ones already found. | Time parameterization | | `motion_core::timing` | Design notes, measurements and open issues are in -[`SPIKE.md`](../SPIKE.md). +[`SPIKE.md`](https://github.com/compas-dev/compas_fab_native/blob/main/SPIKE.md). Credits for ported code and the algorithms followed are in `NOTICE`. diff --git a/docs/index.md b/docs/index.md index f9dbe35..5c199f2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ # Native (experimental) A planning backend whose work happens in a compiled core (Rust) inside the Python process: -no Docker, no PyBullet, no ROS. It is an early spike: the API is the usual compas_fab +no Docker, no PyBullet, no ROS. It is experimental: the API is the usual compas_fab backend API, but what it supports is limited (see below) and may change. ## When to use @@ -23,18 +23,18 @@ backend API, but what it supports is limited (see below) and may change. | Free motion in milliseconds, for any serial robot, timed under velocity and acceleration limits | No jerk limits yet | | Closed-form IK for UR (offset wrist) and spherical-wrist arms; numerical IK (collision-aware) for every other robot | Numerical IK finds solutions from seeds: "no solution" means none was found, not that none exists | | Sphere-model collision checks for thousands of configurations per millisecond, validated on exact meshes, including tools and workpieces the robot carries | Large flat links (gantry carriages, tall bases) are approximated poorly by spheres (`planner.poorly_fitted_links`); the exact check catches what the spheres miss, at the cost of slower plans (`exact_links` checks them during planning too, slower still) | -| Mesh obstacles with holes (distance fields) | Experimental: not on PyPI, built from source | +| Mesh obstacles with holes (distance fields) | Experimental: the API may change between minor versions | ## Setup -From a checkout of this repository, with a [Rust toolchain](https://rustup.rs) installed: - ```bash -pip install . +pip install compas_fab_native ``` -This builds the `compas_fab_native` extension with maturin. For development, -`maturin develop --release` rebuilds it in place. +Wheels are available for Linux (x86_64), macOS (Intel and Apple Silicon) and Windows (x64), +for Python 3.9 and later. Elsewhere, pip builds the extension from source, which needs a +[Rust toolchain](https://rustup.rs). From a checkout of the repository, `pip install -e .` +builds it in place. ## First example @@ -88,8 +88,8 @@ The full explanation, with diagrams, is in [How it works](how-it-works.md). velocity and acceleration limits allow, starting and ending at rest. Design notes, measurements and open issues are in -[`SPIKE.md`](../SPIKE.md). +[`SPIKE.md`](https://github.com/compas-dev/compas_fab_native/blob/main/SPIKE.md). ## API reference -- `compas_fab_native.NativePlanner` +See the [API reference](api.md). diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..4efa18a --- /dev/null +++ b/docs/license.md @@ -0,0 +1,15 @@ +# License + +``` +--8<-- "LICENSE" +``` + +## Third-party code, data and algorithms + +``` +--8<-- "NOTICE" +``` + +The license texts are in the [`licenses/`](https://github.com/compas-dev/compas_fab_native/tree/main/licenses) +folder of the repository, including those of the Rust crates compiled into the extension +(`THIRD_PARTY_RUST.txt`). diff --git a/licenses/THIRD_PARTY_RUST.txt b/licenses/THIRD_PARTY_RUST.txt new file mode 100644 index 0000000..12d9b52 --- /dev/null +++ b/licenses/THIRD_PARTY_RUST.txt @@ -0,0 +1,1455 @@ +Third-party Rust crates compiled into compas_fab_native +======================================================= + +The compiled extension (compas_fab_native/_core) contains code from the Rust crates below. +Their licenses follow, each with the crates it applies to. Generated by cargo-about from +about.toml and about.hbs; do not edit by hand. + +Overview +-------- +MIT License: 57 crate(s) +Apache License 2.0: 3 crate(s) +Unicode License v3: 1 crate(s) +zlib License: 1 crate(s) + +-------------------------------------------------------------------------------- +Apache License 2.0 + +Used by: + approx 0.5.1 (https://github.com/brendanzab/approx) + + + 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 [yyyy] [name of copyright owner] + + 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. + + +-------------------------------------------------------------------------------- +Apache License 2.0 + +Used by: + simba 0.10.2 (https://github.com/dimforge/simba) + + 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 2020 Sébastien Crozet + + 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. + + +-------------------------------------------------------------------------------- +Apache License 2.0 + +Used by: + parry3d 0.31.1 (https://github.com/dimforge/parry) + +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 [yyyy] [name of copyright owner] + +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. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + ena 0.14.4 (https://github.com/rust-lang/ena) + rayon-core 1.13.0 (https://github.com/rayon-rs/rayon) + rayon 1.12.0 (https://github.com/rayon-rs/rayon) + +Copyright (c) 2010 The Rust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + bitflags 2.13.2 (https://github.com/bitflags/bitflags) + log 0.4.35 (https://github.com/rust-lang/log) + num-complex 0.4.6 (https://github.com/rust-num/num-complex) + num-derive 0.5.1 (https://github.com/rust-num/num-derive) + num-traits 0.2.19 (https://github.com/rust-num/num-traits) + +Copyright (c) 2014 The Rust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + either 1.19.0 (https://github.com/rayon-rs/either) + +Copyright (c) 2015 + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + ordered-float 5.5.1 (https://github.com/reem/rust-ordered-float) + +Copyright (c) 2015 Jonathan Reem + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + heck 0.5.0 (https://github.com/withoutboats/heck) + +Copyright (c) 2015 The Rust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + hashbrown 0.16.1 (https://github.com/rust-lang/hashbrown) + hashbrown 0.17.1 (https://github.com/rust-lang/hashbrown) + +Copyright (c) 2016 Amanieu d'Antras + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + equivalent 1.0.3 (https://github.com/indexmap-rs/equivalent) + +Copyright (c) 2016--2023 + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + heapless 0.8.0 (https://github.com/rust-embedded/heapless) + +Copyright (c) 2017 Jorge Aparicio + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + stable_deref_trait 1.2.1 (https://github.com/storyyeller/stable_deref_trait) + +Copyright (c) 2017 Robert Grosse + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + +-------------------------------------------------------------------------------- +MIT License + +Used by: + spade 2.15.1 (https://github.com/Stoeoef/spade) + +Copyright (c) 2017 The Spade Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + robust 1.2.0 (https://github.com/georust/robust) + +Copyright (c) 2017 The Spade Developers +Copyright (c) 2020 The GeoRust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + hash32 0.3.1 (https://github.com/japaric/hash32) + +Copyright (c) 2018 Jorge Aparicio + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + smallvec 1.16.5 (https://github.com/servo/rust-smallvec) + +Copyright (c) 2018 The Servo Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + slab 0.4.12 (https://github.com/tokio-rs/slab) + +Copyright (c) 2019 Carl Lerche + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + downcast-rs 2.0.2 (https://github.com/marcianx/downcast-rs) + +Copyright (c) 2020 Ashish Myles and contributors + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + pyo3-ffi 0.30.1 (https://github.com/pyo3/pyo3) + pyo3-macros-backend 0.30.1 (https://github.com/pyo3/pyo3) + pyo3-macros 0.30.1 (https://github.com/pyo3/pyo3) + pyo3 0.30.1 (https://github.com/pyo3/pyo3) + pyo3 0.30.1 (https://github.com/pyo3/pyo3) + +Copyright (c) 2023-present PyO3 Project and Contributors. https://github.com/PyO3 + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + libc 0.2.191 (https://github.com/rust-lang/libc) + +Copyright (c) The Rust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + arrayvec 0.7.8 (https://github.com/bluss/arrayvec) + +Copyright (c) Ulrik Sverdrup "bluss" 2015-2023 + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + static_assertions 1.1.0 (https://github.com/nvzqz/static-assertions-rs) + +MIT License + +Copyright (c) 2017 Nikolai Vazquez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + bytemuck 1.25.2 (https://github.com/Lokathor/bytemuck) + bytemuck_derive 1.12.1 (https://github.com/Lokathor/bytemuck) + +MIT License + +Copyright (c) 2019 Daniel "Lokathor" Gee. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + wide 1.7.1 (https://github.com/Lokathor/wide) + +MIT License + +Copyright (c) 2020 Daniel "Lokathor" Gee + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + safe_arch 1.2.0 (https://github.com/Lokathor/safe_arch) + +MIT License + +Copyright (c) 2023 Daniel "Lokathor" Gee. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + libm 0.2.16 (https://github.com/rust-lang/compiler-builtins) + rstar 0.13.1 (https://github.com/georust/rstar) + +MIT License + +Copyright (c) <year> <copyright holders> + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the +following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO +EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +USE OR OTHER DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + glam 0.33.12 (https://github.com/bitshifter/glam-rs) + glamx 0.3.1 (https://github.com/dimforge/glamx) + itoa 1.0.18 (https://github.com/dtolnay/itoa) + once_cell 1.21.4 (https://github.com/matklad/once_cell) + proc-macro2 1.0.107 (https://github.com/dtolnay/proc-macro2) + quote 1.0.47 (https://github.com/dtolnay/quote) + serde 1.0.229 (https://github.com/serde-rs/serde) + serde_core 1.0.229 (https://github.com/serde-rs/serde) + serde_derive 1.0.229 (https://github.com/serde-rs/serde) + serde_json 1.0.154 (https://github.com/serde-rs/json) + syn 3.0.9 (https://github.com/dtolnay/syn) + thiserror-impl 2.0.21 (https://github.com/dtolnay/thiserror) + thiserror 2.0.21 (https://github.com/dtolnay/thiserror) + unicode-ident 1.0.27 (https://github.com/dtolnay/unicode-ident) + zmij 1.0.23 (https://github.com/dtolnay/zmij) + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + allocator-api2 0.2.21 (https://github.com/zakarumych/allocator-api2) + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + byteorder 1.5.0 (https://github.com/BurntSushi/byteorder) + memchr 2.8.3 (https://github.com/BurntSushi/memchr) + +The MIT License (MIT) + +Copyright (c) 2015 Andrew Gallant + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +-------------------------------------------------------------------------------- +MIT License + +Used by: + crossbeam-deque 0.8.8 (https://github.com/crossbeam-rs/crossbeam) + crossbeam-epoch 0.9.21 (https://github.com/crossbeam-rs/crossbeam) + crossbeam-utils 0.8.23 (https://github.com/crossbeam-rs/crossbeam) + +The MIT License (MIT) + +Copyright (c) 2019 The Crossbeam Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- +Unicode License v3 + +Used by: + unicode-ident 1.0.27 (https://github.com/dtolnay/unicode-ident) + +UNICODE LICENSE V3 + +COPYRIGHT AND PERMISSION NOTICE + +Copyright © 1991-2023 Unicode, Inc. + +NOTICE TO USER: Carefully read the following legal agreement. BY +DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR +SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE +TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT +DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of data files and any associated documentation (the "Data Files") or +software and any associated documentation (the "Software") to deal in the +Data Files or Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, and/or sell +copies of the Data Files or Software, and to permit persons to whom the +Data Files or Software are furnished to do so, provided that either (a) +this copyright and permission notice appear with all copies of the Data +Files or Software, or (b) this copyright and permission notice appear in +associated Documentation. + +THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF +THIRD PARTY RIGHTS. + +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE +BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, +OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, +WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, +ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA +FILES OR SOFTWARE. + +Except as contained in this notice, the name of a copyright holder shall +not be used in advertising or otherwise to promote the sale, use or other +dealings in these Data Files or Software without prior written +authorization of the copyright holder. + + +-------------------------------------------------------------------------------- +zlib License + +Used by: + foldhash 0.2.0 (https://github.com/orlp/foldhash) + +Copyright (c) 2024 Orson Peters + +This software is provided 'as-is', without any express or implied warranty. In +no event will the authors be held liable for any damages arising from the use of +this software. + +Permission is granted to anyone to use this software for any purpose, including +commercial applications, and to alter it and redistribute it freely, subject to +the following restrictions: + +1. The origin of this software must not be misrepresented; you must not claim + that you wrote the original software. If you use this software in a product, + an acknowledgment in the product documentation would be appreciated but is + not required. + +2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + +3. This notice may not be removed or altered from any source distribution. + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..e549d69 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,104 @@ +site_name: COMPAS FAB Native +site_url: https://compas.dev/compas_fab_native/ +repo_url: https://github.com/compas-dev/compas_fab_native +repo_name: compas-dev/compas_fab_native +edit_uri: blob/main/docs/ + +copyright: Copyright © 2018 - 2026, Gramazio Kohler Research + +exclude_docs: | + diagrams/build.py + **/__pycache__/ + +extra: + homepage: https://compas.dev/compas_fab_native/ + version: + provider: mike + +theme: + name: material + palette: + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode + font: + text: Roboto + code: Roboto Mono + logo: _logo/compas_logo_white_transparent.png + favicon: _logo/favicon.ico + features: + - content.code.copy + - navigation.footer + - navigation.indexes + - navigation.sections + - navigation.top + - search.highlight + - search.suggest + - toc.follow + +extra_css: + - assets/stylesheets/custom.css + +markdown_extensions: + - abbr + - attr_list + - admonition + - callouts: + strip_period: no + - footnotes + - md_in_html + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.superfences + - pymdownx.snippets: + check_paths: true + - toc: + permalink: "¤" + +plugins: + - search + - mkdocstrings: + default_handler: python + handlers: + python: + paths: [src] + inventories: + - https://docs.python.org/3/objects.inv + - https://compas.dev/compas/latest/objects.inv + - https://compas.dev/compas_fab/latest/objects.inv + options: + allow_inspection: true + docstring_options: + ignore_init_summary: true + docstring_style: numpy + docstring_section_style: list + filters: public + heading_level: 2 + inherited_members: false + merge_init_into_class: true + separate_signature: true + show_bases: true + show_root_heading: true + show_root_full_path: true + show_signature_annotations: true + show_source: false + signature_crossrefs: true + +nav: + - Home: index.md + - How it works: how-it-works.md + - API reference: api.md + - Changelog: changelog.md + - License: license.md diff --git a/pyproject.toml b/pyproject.toml index 06116f9..4a4b343 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,23 +2,135 @@ requires = ["maturin>=1.9,<2"] build-backend = "maturin" +# ============================================================================ +# project info +# ============================================================================ + [project] name = "compas_fab_native" description = "Native (Rust) planning backend for compas_fab: batched kinematics, collision checks, Cartesian and free-motion planning." +keywords = ["robotics", "motion planning", "inverse kinematics", "collision checking", "compas", "compas_fab", "digital fabrication"] readme = "README.md" requires-python = ">=3.9" license = "MIT" license-files = ["LICENSE", "NOTICE", "licenses/*.txt"] authors = [{ name = "Gramazio Kohler Research", email = "gramaziokohler@arch.ethz.ch" }] classifiers = [ - "Programming Language :: Rust", + "Development Status :: 3 - Alpha", + "Intended Audience :: Science/Research", + "Topic :: Scientific/Engineering", + "Operating System :: MacOS", + "Operating System :: Microsoft :: Windows", + "Operating System :: POSIX :: Linux", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Rust", ] dynamic = ["version"] dependencies = ["compas_fab>=2.1,<3", "numpy"] +[project.optional-dependencies] +dev = [ + "bump-my-version", + "maturin >=1.9,<2", + "pytest", + "ruff", +] +docs = [ + "markdown-callouts >=0.4", + "mike", + "mkdocs >=1.6", + "mkdocs-autorefs >=1.4", + "mkdocs-material >=9.5", + "mkdocstrings[python]", +] + +[project.urls] +Homepage = "https://compas.dev/compas_fab_native" +Documentation = "https://compas.dev/compas_fab_native" +Repository = "https://github.com/compas-dev/compas_fab_native" +Changelog = "https://github.com/compas-dev/compas_fab_native/blob/main/CHANGELOG.md" +Issues = "https://github.com/compas-dev/compas_fab_native/issues" +Forum = "https://forum.compas-framework.org/" + +# ============================================================================ +# build (maturin): the version comes from crates/motion_py/Cargo.toml +# ============================================================================ + [tool.maturin] manifest-path = "crates/motion_py/Cargo.toml" module-name = "compas_fab_native._core" python-source = "src" features = ["pyo3/extension-module"] + +# ============================================================================ +# tests +# ============================================================================ + +[tool.pytest.ini_options] +testpaths = ["tests"] + +# ============================================================================ +# linting and formatting +# ============================================================================ + +[tool.ruff] +line-length = 179 +indent-width = 4 +target-version = "py39" + +[tool.ruff.lint] +select = ["E", "F", "I"] + +[tool.ruff.lint.per-file-ignores] +"__init__.py" = ["I001"] +"tests/*" = ["I001", "E501"] + +[tool.ruff.lint.isort] +force-single-line = true +known-first-party = ["compas_fab_native"] + +[tool.ruff.lint.pycodestyle] +max-doc-length = 179 + +[tool.ruff.format] +# Markdown code blocks hold mkdocs snippet includes (--8<--), not Python to format. +exclude = ["*.md"] + +# ============================================================================ +# release (compas-dev/compas-actions: release-pr bumps these, release-check +# allows a release to change only these files) +# ============================================================================ + +[tool.bumpversion] +current_version = "0.0.0" +message = "Bump version to {new_version}" +commit = false +tag = false + +[[tool.bumpversion.files]] +filename = "crates/motion_py/Cargo.toml" +search = "version = \"{current_version}\"" +replace = "version = \"{new_version}\"" + +[[tool.bumpversion.files]] +filename = "Cargo.lock" +search = "name = \"motion_py\"\nversion = \"{current_version}\"" +replace = "name = \"motion_py\"\nversion = \"{new_version}\"" + +[[tool.bumpversion.files]] +filename = "src/compas_fab_native/__init__.py" +search = "__version__ = \"{current_version}\"" +replace = "__version__ = \"{new_version}\"" + +[[tool.bumpversion.files]] +filename = "CHANGELOG.md" +search = "Unreleased" +replace = "[{new_version}] {now:%Y-%m-%d}" diff --git a/scripts/baseline_cartesian.py b/scripts/baseline_cartesian.py index aa4a088..9c6bc5e 100644 --- a/scripts/baseline_cartesian.py +++ b/scripts/baseline_cartesian.py @@ -20,7 +20,6 @@ from compas.geometry import Box from compas.geometry import Frame - from compas_fab.backends import AnalyticalPyBulletClient from compas_fab.backends import AnalyticalPyBulletPlanner from compas_fab.backends import PyBulletClient diff --git a/scripts/baseline_python.py b/scripts/baseline_python.py index dd8c588..7518d6f 100644 --- a/scripts/baseline_python.py +++ b/scripts/baseline_python.py @@ -22,7 +22,6 @@ import numpy as np from compas.geometry import Box from compas.geometry import Frame - from compas_fab.backends import CollisionCheckError from compas_fab.backends import PyBulletClient from compas_fab.backends import PyBulletPlanner diff --git a/scripts/export_meshes.py b/scripts/export_meshes.py index 775db14..37b5e16 100644 --- a/scripts/export_meshes.py +++ b/scripts/export_meshes.py @@ -8,9 +8,10 @@ import argparse import json -from compas_fab_native.model import exact_robot_meshes from compas_fab.robots import RobotCellLibrary +from compas_fab_native.model import exact_robot_meshes + def main(): parser = argparse.ArgumentParser() diff --git a/scripts/export_robot.py b/scripts/export_robot.py index 83e4dfe..bf52004 100644 --- a/scripts/export_robot.py +++ b/scripts/export_robot.py @@ -26,7 +26,6 @@ import numpy as np from compas.geometry import Frame from compas.geometry import Transformation - from compas_fab import backends from compas_fab.robots import RobotCellLibrary diff --git a/src/compas_fab_native/__init__.py b/src/compas_fab_native/__init__.py index 4967c10..ee14729 100644 --- a/src/compas_fab_native/__init__.py +++ b/src/compas_fab_native/__init__.py @@ -1,11 +1,13 @@ -"""Native (Rust) motion core backend for compas_fab: spike, see ``SPIKE.md``. +"""Native (Rust) planning backend for compas_fab. -``NativeCore`` comes from the compiled extension ``compas_fab_native._core``, built with -maturin from ``crates/motion_py``. +``NativePlanner`` is the backend; ``NativeCore`` is the compiled core it drives, from the +extension module ``compas_fab_native._core``. """ from ._core import NativeCore from .planner import NativeClient from .planner import NativePlanner +__version__ = "0.0.0" + __all__ = ["NativeClient", "NativeCore", "NativePlanner"] diff --git a/src/compas_fab_native/planner.py b/src/compas_fab_native/planner.py index 55007e3..33d9401 100644 --- a/src/compas_fab_native/planner.py +++ b/src/compas_fab_native/planner.py @@ -20,8 +20,6 @@ import numpy as np from compas.geometry import Frame from compas.geometry import Transformation -from compas_robots import Configuration - from compas_fab.backends.exceptions import CollisionCheckError from compas_fab.backends.exceptions import InverseKinematicsError from compas_fab.backends.exceptions import MPNoIKSolutionError @@ -47,6 +45,7 @@ from compas_fab.robots import PointAxisTarget from compas_fab.robots import PointAxisWaypoints from compas_fab.robots import TargetMode +from compas_robots import Configuration from ._core import NativeCore from .model import add_carried_objects