Skip to content
Merged
Show file tree
Hide file tree
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
96 changes: 38 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,50 @@
# MoveIt Pro Example Workspace

This is fork of the [MoveIt Pro Empty Workspace](https://github.com/PickNikRobotics/moveit_pro_empty_ws).
This workspace contains reference materials for using MoveIt Pro, including:
- [Example base UR5e configuration](src/moveit_pro_ur_configs/picknik_ur_base_config)
- [A physics based simulation environment with a robot on a linear rail](src/lab_sim)
- [Mobile manipulation configuration](src/hangar_sim)
- [Example behaviors](src/example_behaviors)
This workspace contains reference materials for using MoveIt Pro, including example robot configurations, simulated environments, and reusable behaviors.

Since the [picknik_accessories](https://github.com/PickNikRobotics/picknik_accessories) package uses git LFS, [it cannot be added as a subtree](https://github.com/git-lfs/git-lfs/issues/854).
Please ensure you have the submodule up to date using:
## Cloning

This repository uses git submodules. Clone with:
```bash
git submodule update --recursive --init
git submodule foreach --recursive git lfs pull
git clone --recurse-submodules <repo-url>
```

## Working with Git Subtrees

This repository was created through the combination of multiple repositories using git subtree.
If you have no interest in manually pulling or pushing upstream changes, you can ignore the following section and treat this repository as a single repository.

### Repository Structure


The structure of this repository is as follows:

<pre>
.
├── <a href="README.md">README.md</a>
└── src
├── <a href="https://github.com/PickNikRobotics/example_behaviors">example_behaviors</a>
├── <a href="https://github.com/PickNikRobotics/lab_sim">lab_sim</a>
├── <a href="https://github.com/PickNikRobotics/moveit_pro_ur_configs">moveit_pro_ur_configs</a>
│ ├── picknik_ur_base_config
│ ├── mock_sim
│ ├── multi_arm_sim
│ ├── picknik_ur_sim_config
│ └── picknik_ur_site_config
├── <a href="https://github.com/PickNikRobotics/moveit_pro_kinova_configs">moveit_pro_kinova_configs</a>
│ ├── kinova_gen3_base_config
│ ├── kinova_sim
│ └── moveit_studio_kinova_pstop_manager
├── <a href="https://github.com/PickNikRobotics/moveit_pro_mobile_manipulation">moveit_pro_mobile_manipulation</a>
│ ├── mobile_manipulation_config
│ └── picknik_ur_mobile_config
├── <a href="https://github.com/PickNikRobotics/fanuc_sim">fanuc_sim</a>
├── <a href="https://github.com/PickNikRobotics/picknik_accessories">picknik_accessories</a> (submodule)
└── external_dependencies
├── <a href="https://github.com/sjahr/ridgeback/tree/ros2">ridgeback</a>
├── <a href="https://github.com/PickNikRobotics/ros2_robotiq_gripper">ros2_robotiq_gripper</a>
└── <a href="https://github.com/tylerjw/serial/tree/ros2">serial</a>
</pre>

This repository contains a **copy** of the git repositories that were added as subtrees.
File changes and commits are treated as if they happen only in this repository.
If you update the contents of a subtree, you can merge the latest `main` branch of [lab_sim](https://github.com/PickNikRobotics/lab_sim) using the following command:
If you already cloned without submodules, initialize them with:
```bash
git subtree pull --prefix src/lab_sim https://github.com/PickNikRobotics/lab_sim main --squash
git submodule update --recursive --init
```

To pull the upstream changes to all subtrees and submodules, a convenience script is provided.
From the top level, you can execute:
Several submodules (notably `picknik_accessories`) use git LFS. Install [git-lfs](https://git-lfs.com/) first (e.g., `sudo apt install git-lfs && git lfs install`); without it the commands below fail with `git: 'lfs' is not a git command`. After updating submodules, pull LFS objects:
```bash
./sync_subtrees.sh
git submodule foreach --recursive git lfs pull
```

## Scripts

Utility scripts for maintaining the PickNik website are located in the `scripts/` directory.
See [scripts/README.md](scripts/README.md) for documentation.
## Robot Configs

- `april_tag_sim`
- `dual_arm_sim`
- `factory_sim`
- `grinding_sim`
- `hangar_sim`
- `kitchen_sim`
- `lab_sim`
- `lunar_sim`
- `phoebe_sim`
- `moveit_pro_franka_configs/franka_base_config`
- `moveit_pro_kinova_configs/kinova_gen3_base_config`
- `moveit_pro_kinova_configs/kinova_gen3_site_config`
- `moveit_pro_kinova_configs/kinova_sim`
- `moveit_pro_kinova_configs/space_satellite_sim`
- `moveit_pro_kinova_configs/space_satellite_sim_camera_cal`
- `moveit_pro_ur_configs/mock_sim`
- `moveit_pro_ur_configs/multi_arm_sim`
- `moveit_pro_ur_configs/picknik_ur_base_config`
- `moveit_pro_ur_configs/picknik_ur_site_config`

## Updating Submodules

To pull the latest commits for all submodules:
```bash
git submodule update --remote --recursive
git submodule foreach --recursive git lfs pull
```
92 changes: 0 additions & 92 deletions scripts/README.md

This file was deleted.

Loading
Loading