Skip to content

document installation, the projectors and the explorer - #14

Open
zeerekahmad wants to merge 1 commit into
zeerekahmad/kinematic-explorerfrom
zeerekahmad/kinematics-docs
Open

document installation, the projectors and the explorer#14
zeerekahmad wants to merge 1 commit into
zeerekahmad/kinematic-explorerfrom
zeerekahmad/kinematics-docs

Conversation

@zeerekahmad

Copy link
Copy Markdown
Contributor

PR: document installation, the projectors and the explorer

  • branch: zeerekahmad/kinematics-docs
  • base: zeerekahmad/kinematic-explorer
  • commit: 879071d

Description

Documentation for everything the stack added.

  • The README gained three installation paths that did not exist before — wheel via uv/pip, ROS2 via colcon,
    and standalone CMake — plus how to run the explorer and how to run each test suite, and worked Python and
    C++ examples for the projectors covering footprints, the axle reference and the ramp semantics.
  • The derivations pick up the forward-projection integration for each model: the steering and articulation
    ramps, the gamma-dot term now that it is a real input rather than a hardcoded zero, and how the
    axle-reference conversion is applied without changing where motion is integrated.

Migration Guide

N/A — documentation only.

Related issues

Completeness checklist

  • Is there test coverage? If it was a bugfix, is there a regression test?
  • Is user-facing API/behavior documented?
  • Is core documentation updated?
  • Are all checks green?
  • Assign reviewers to the PR and post in #code_reviews

Stack created with GitHub Stacks CLIGive Feedback 💬

The README gained three installation paths that did not exist before - wheel via uv/pip,
ROS2 via colcon, and standalone CMake - plus how to run the explorer and how to run each
test suite, and worked Python and C++ examples for the projectors covering footprints,
the axle reference and the ramp semantics.

The derivations pick up the forward-projection integration for each model: the steering
and articulation ramps, the gamma-dot term now that it is a real input rather than a
hardcoded zero, and how the axle-reference conversion is applied without changing where
motion is integrated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant