forked from ami-iit/jaxsim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add examples' README and rename
pixi run
command
- Loading branch information
1 parent
cc8f4f1
commit ff74624
Showing
2 changed files
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# JAXsim Notebook Examples | ||
|
||
This folder includes a Jupyter Notebook demonstrating practical usage of JAXsim for system simulations. | ||
|
||
### Examples | ||
|
||
- [PD_controller](./PD_controller.ipynb) - A simple example demonstrating the use of JAXsim to simulate a PD controller with gravity compensation for a 2-DOF cartpole. | ||
|
||
> [!TIP] | ||
> Stay tuned for more examples! | ||
## Running the Examples | ||
|
||
To execute these examples utilizing JAXsim with hardware acceleration, there are a couple of options available: | ||
|
||
### 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: | ||
|
||
1. **Install `pixi`:** | ||
|
||
As per the [official documentation](https://pixi.sh/#installation): | ||
|
||
```bash | ||
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 | ||
``` | ||
|
||
This command will automatically handle the installation of necessary dependencies and execute the examples within a self-contained environment |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters