Feature/demos

[blooop]

Summary by Sourcery

Add a 'Demo' section to the README.md to guide users on running demos with pixi.

Documentation:

• Add a new 'Demo' section to the README.md with instructions on how to run demos using pixi.

Summary by CodeRabbit

• New Features

  • Added a "Demo" section to the README, providing instructions for running demo tasks.
  • Introduced two new demo tasks: demo_task_space and demo_impedance, enhancing task management capabilities.

• Documentation

  • Improved usability of the README by including practical usage examples for users.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a new section to the README.md file, introducing demo instructions for running the project using the pixi tool. The changes are focused on improving the documentation and providing clear guidance for users to run demo tasks.

File-Level Changes

Change	Details	Files
Added a new 'Demo' section to the README	Introduced instructions for running demos using pixi Added two demo commands: demo_task_space and demo_impedance Specified the requirement of having pixi installed	README.md

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[coderabbitai]

Walkthrough

The changes involve updates to the README.md and pyproject.toml files. A new "Demo" section was added to the README to provide instructions for running demo tasks using the pixi tool. In the pyproject.toml, the build system was switched from setuptools to hatchling, and new demo tasks were defined to facilitate running specific Python scripts.

Changes

Files	Change Summary
README.md, pyproject.toml	Added a "Demo" section to the README with usage instructions. Updated pyproject.toml to switch build system to hatchling and define demo tasks for executing Python scripts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant README
    participant pixi
    participant PythonScript

    User->>README: Check demo instructions
    README->>User: Provide usage commands
    User->>pixi: Execute demo_task_space
    pixi->>PythonScript: Run demo_task_space_control.py
    User->>pixi: Execute demo_impedance
    pixi->>PythonScript: Run demo_impedance_control.py

Loading

Poem

🐰 In the garden where bunnies play,
New demos bloom in a bright array.
With hatchling now, our tasks take flight,
Running scripts brings pure delight!
So hop along, come join the fun,
With every command, new joys begun! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sourcery-ai]

Hey @blooop - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a brief note about how to install 'pixi' or provide an alternative method for running the demos for users who don't have it installed.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 2 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 26e2e70 and b01992b.

Files ignored due to path filters (1)

• pixi.lock is excluded by !**/*.lock

Files selected for processing (2)

• README.md (1 hunks)
• pyproject.toml (2 hunks)

Files skipped from review due to trivial changes (1)

• README.md

Additional comments not posted (1)

pyproject.toml (1)

16-17: Review the transition to Hatchling build system.

The changes to use hatchling as the build system are noted. This is a significant shift from setuptools and should be carefully evaluated for compatibility with existing CI/CD pipelines and developer workflows.

Please ensure to test the build process thoroughly to confirm that all functionalities work as expected with the new build backend.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b01992b and d09ce1c.

Files ignored due to path filters (1)

• pixi.lock is excluded by !**/*.lock

Files selected for processing (2)

• README.md (1 hunks)
• pyproject.toml (2 hunks)

Files skipped from review as they are similar to previous changes (2)

• README.md
• pyproject.toml

[justagist]

• The python file pointed by the demo_impedance task is not an executable script and just contains the controller definitions for the other demo script.

• The other demo script works, but the controller is not performing well enough to be exposed as a demo for this package as of now. There is possibly a preexisting bug in that example/controller implementation, or requires more tuning.

• remove demo_impedance task

• consider fixing demo before exposing it to user as a pixi task