Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update drake_cmake_installed README #367

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 66 additions & 33 deletions drake_cmake_installed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,86 @@ This uses the CMake `find_package(drake)` mechanism to find an installed instanc

# Instructions

These instructions are only supported for Ubuntu 22.04 (Jammy).
## Download and Install Prerequisites

First, run the `install_prereqs` script to download the
Drake source to `$HOME/drake/`. This also run's Drake's
setup script to install the required packages depending
on your operating system:

```bash
###############################################################
# Download Drake and Install Prerequisites
###############################################################
setup/install_prereqs
```

# Download Drake source to $HOME/drake/ and
# install various system dependencies
sudo setup/install_prereqs
See [below](#alternative-versions) for alternative versions of
Drake to download.

###############################################################
# Alternative Drake Versions
###############################################################
## Build Everything

# The script above gets the latest version of Drake (usually
# last night's build). Ignore this step if that version is desired.
# Otherwise, the following are alternative options for which
# version of Drake to download:
Then run the following to build using CMake from the current directory
(`drake-external-examples/drake_cmake_installed`):

# 1) A specific version (date-stamped)
curl -O https://drake-packages.csail.mit.edu/drake/nightly/drake-20240214-jammy.tar.gz
tar -xvzf drake-20240214-jammy.tar.gz -C $HOME
```bash
mkdir build && cd build
cmake -DCMAKE_PREFIX_PATH=$HOME/drake ..
make
```

# 2) Manual Installation
git clone https://github.com/RobotLocomotion/drake.git
(cd drake && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=$HOME/drake .. && make)
You can also optionally run the tests by calling `make test`.

# 3) Manual Installation w/ Licensed Gurobi
# Install & setup gurobi (http://drake.mit.edu/bazel.html?highlight=gurobi#install-on-ubuntu)
## Alternative Versions

By default, `install_prereqs` script gets the latest version
of Drake (usually last night's build). Ignore this if that
version is desired. Otherwise, the following are alternative
options for which version of Drake to download.

To use any of these options, instead of running `install_prereqs`,
run the code for whichever option you prefer below. Each option
downloads Drake to the `$HOME` directory.

1. A specific version (date-stamped)

Replace `jammy` (for Ubuntu 22.04) with `noble` or `mac-arm64`
to download the version needed for your operating system.

```bash
curl -O https://drake-packages.csail.mit.edu/drake/nightly/drake-0.0.20250131-jammy.tar.gz
tar -xvzf drake-0.0.20250131-jammy.tar.gz -C $HOME
$HOME/drake/share/drake/setup/install_prereqs # install prereqs
```

See [Installation via Direct Download](https://drake.mit.edu/from_binary.html)
for more information.

2. Manual installation

If on Mac, adjust the call to install prereqs to replace `ubuntu` with `mac`
and remove the use of `sudo`.

```bash
git clone https://github.com/RobotLocomotion/drake.git
(cd drake && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=$HOME/drake -DWITH_GUROBI=ON .. && make)
cd drake
sudo setup/ubuntu/source_distribution/install_prereqs.sh # install prereqs
(mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=$HOME/drake .. && make)
```

###############################################################
# Build Everything
###############################################################
3. Manual installation w/ licensed Gurobi
Install & setup gurobi (http://drake.mit.edu/bazel.html?highlight=gurobi#install-on-ubuntu)

git clone https://github.com/RobotLocomotion/drake-external-examples.git
cd drake-external-examples/drake_cmake_installed
mkdir build && cd build
cmake -DCMAKE_PREFIX_PATH=$HOME/drake ..
make
If on Mac, adjust the call to install prereqs to replace `ubuntu` with `mac`
and remove the use of `sudo`.

# (Optionally) Run Tests
make test
```bash
git clone https://github.com/RobotLocomotion/drake.git
cd drake
sudo setup/ubuntu/source_distribution/install_prereqs.sh # install prereqs
(mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=$HOME/drake -DWITH_GUROBI=ON .. && make)
```

Finally, for the code in this example, ensure you have `python3-all-dev`
installed if on Ubuntu.

# Examples

Drake-specific examples:
Expand Down
Loading