Skip to content

Commit

Permalink
Add additional notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Giulero committed Jun 27, 2024
1 parent 235f054 commit e5f3ca3
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Other requisites are:
- `casadi`
- `pytorch`
- `numpy`
- `jax2torch`

They will be installed in the installation step!

Expand Down Expand Up @@ -116,6 +117,9 @@ mamba create -n adamenv -c conda-forge adam-robotics

If you want to use `jax` or `pytorch`, just install the corresponding package as well.

> [!NOTE]
> Check also the conda JAX installation guide [here](https://jax.readthedocs.io/en/latest/installation.html#conda-community-supported)
### 🔨 Installation from repo

Install in a conda environment the required dependencies:
Expand All @@ -135,13 +139,13 @@ Install in a conda environment the required dependencies:
- **PyTorch** interface dependencies:

```bash
mamba create -n adamenv -c conda-forge pytorch numpy lxml prettytable matplotlib urdfdom-py
mamba create -n adamenv -c conda-forge pytorch numpy lxml prettytable matplotlib urdfdom-py jax2torch
```

- **ALL** interfaces dependencies:

```bash
mamba create -n adamenv -c conda-forge jax casadi pytorch numpy lxml prettytable matplotlib urdfdom-py
mamba create -n adamenv -c conda-forge jax casadi pytorch numpy lxml prettytable matplotlib urdfdom-py jax2torch
```

Activate the environment, clone the repo and install the library:
Expand All @@ -156,10 +160,13 @@ pip install --no-deps .
## 🚀 Usage

The following are small snippets of the use of **adam**. More examples are arriving!
Have also a look at te `tests` folder.
Have also a look at the `tests` folder.

### Jax interface

> [!NOTE]
> Check also the Jax installation guide [here](https://jax.readthedocs.io/en/latest/installation.html#)
```python
import adam
from adam.jax import KinDynComputations
Expand Down

0 comments on commit e5f3ca3

Please sign in to comment.