Skip to content

Commit

Permalink
Merge pull request #144 from ami-iit/fix/examples
Browse files Browse the repository at this point in the history
Add missing dependency in `pixi.toml`
  • Loading branch information
flferretti committed Apr 24, 2024
2 parents 98055c3 + 2caa0f9 commit 8dc5c8c
Show file tree
Hide file tree
Showing 5 changed files with 12,076 additions and 11,968 deletions.
9 changes: 3 additions & 6 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JAXsim Notebook Examples

This folder includes a Jupyter Notebook demonstrating practical usage of JAXsim for system simulations.
This folder includes a Jupyter Notebook demonstrating the practical usage of JAXsim for system simulations.

### Examples

Expand All @@ -17,6 +17,7 @@ To execute these examples utilizing JAXsim with hardware acceleration, there are
### Option 1: Google Colab (Recommended)

The simplest way to run the examples is by accessing the provided Google Colab notebook link mentioned above. This will enable you to execute the examples in a hosted environment.

### Option 2: Local Execution with `pixi`

For local execution, follow these steps:
Expand All @@ -31,10 +32,6 @@ curl -fsSL https://pixi.sh/install.sh | bash

2. **Run the Example Notebook:**

Use `pixi run <notebook_name>` to execute the example notebook locally, e.g.:

```bash
pixi run PD_controller
```
Use `pixi run examples` from the project source directory to execute the example notebook locally.

This command will automatically handle the installation of necessary dependencies and execute the examples within a self-contained environment
Loading

0 comments on commit 8dc5c8c

Please sign in to comment.