Skip to content

Commit d124a61

Browse files
lucaslibshutzCarlottaSartoreflferretti
authored
minor update readme
* added GPU note and fixed some typos * fixed minor formatting issues from prettier linter * Update Readme * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Filippo Luca Ferretti <[email protected]> --------- Co-authored-by: Carlotta Sartore <[email protected]> Co-authored-by: Filippo Luca Ferretti <[email protected]>
1 parent 56c5ad7 commit d124a61

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Follow the [PEP 8](https://peps.python.org/pep-0008/) style guide and include re
5252
## Testing :test_tube:
5353

5454
Your code will be tested with the CI/CD pipeline before merging.
55-
Feel free to add new ones or update the existing tests in the [workflows](./github/workflows) folder to cover your changes.
55+
Feel free to add new ones or update the existing tests in the [workflows](./.github/workflows) folder to cover your changes.
5656

5757
## Documentation :book:
5858

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,18 @@
1717
<br/>
1818
</div>
1919

20-
21-
2220
## Features
2321

2422
- Physically consistent differentiability w.r.t. hardware parameters.
2523
- Closed chain dynamics support.
2624
- Reduced-coordinate physics engine for **fixed-base** and **floating-base** robots.
27-
- Fully Python-based, leveraging [jax][jax] following a functional programming paradigm.
25+
- Fully Python-based, leveraging [JAX][jax] following a functional programming paradigm.
2826
- Seamless execution on CPUs, GPUs, and TPUs.
2927
- Supports JIT compilation and automatic vectorization for high performance.
3028
- Compatible with SDF models and URDF (via [sdformat][sdformat] conversion).
3129

32-
3330
> [!WARNING]
34-
> This project is still experimental, APIs could change between releases without notice.
31+
> This project is still experimental. APIs may change between releases without notice.
3532
3633
> [!NOTE]
3734
> JaxSim currently focuses on locomotion applications.
@@ -88,6 +85,7 @@ for _ in T:
8885

8986
Check the example folder for additional use cases!
9087

88+
> [!NOTE]
9189
[jax]: https://github.com/google/jax/
9290
[sdformat]: https://github.com/gazebosim/sdformat
9391
[notation]: https://research.tue.nl/en/publications/multibody-dynamics-notation-version-2
@@ -217,11 +215,12 @@ The JaxSim API documentation is available at [jaxsim.readthedocs.io][readthedocs
217215
[readthedocs]: https://jaxsim.readthedocs.io/
218216

219217
## Additional features
220-
Jaxsim can also be used as a multi-body dynamic library! With full support for automatic differentiation of RBDAs (forwards and reverse mode) and automatic differentiation against both kinematic and dynamic parameters.
221218

219+
Jaxsim can also be used as a multi-body dynamics library! With full support for automatic differentiation of RBDAs (forwards and reverse mode) and automatic differentiation against both kinematic and dynamic parameters.
222220

223221
### Using JaxSim as a multibody dynamics library
224-
``` python
222+
223+
```python
225224
import pathlib
226225

227226
import icub_models

0 commit comments

Comments
 (0)