Skip to content

Commit

Permalink
Added documentation for core snp packages (#139)
Browse files Browse the repository at this point in the history
* Added documentation for core snp packages

---------

Co-authored-by: Michael Ripperger <michael.ripperger@swri.org>
  • Loading branch information
DavidSpielman and marip8 authored Sep 9, 2024
1 parent c57ab6f commit b52fc2b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ Framework for developing and operating simple Scan 'N Plan applications in which
- Plans robot motions to execute the tool path
- Executes the process path

## Core Packages

- **snp_application** - Contains a GUI application `Qt` widget, behavior tree plugins, and behavior tree configuration files
- **snp_motion_execution** - Contains files to simulate robotic motion
- **snp_motion_planning** - Contains a planning server based on `tesseract` for generating freespace and process motions; contains custom `tesseract` inverse kinematics plugins, planning task plugins, and planner profiles
- **snp_msgs** - Contains ROS message and service definitions generating tool paths and motion plans, and executing robot trajectories
- **snp_scanning** - Contains files to convert a YAML file into a robot scan path and to simulate `industrial_reconstruction`
- **snp_tpp** - Contains custom tool path planning GUI widgets and source code for the region of interest selection mesh modifier and SNP-specific raster tool path planner

## Build Setup

1. Install the source dependencies after cloning this repository into a `colcon` workspace
Expand Down

0 comments on commit b52fc2b

Please sign in to comment.