Skip to content

Commit 6802acc

Browse files
author
Murilo Marinho
committed
[README] Moving overview to the top, adding dropboxes.
1 parent 05e5d93 commit 6802acc

File tree

1 file changed

+51
-45
lines changed

1 file changed

+51
-45
lines changed

docs/README.md

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
11
# SAS
22

3-
> [!NOTE]
4-
> If being read on GitHub, please note that this page is better seen at https://smartarmstack.github.io.
3+
The SmartArmStack (`sas`) has been developed (with this name) in support of the [SmartArm robot](https://www.youtube.com/watch?v=dayuW47PKKc&list=PLwlAbCcz-l4th0eD8DCTSjyUo3rKeTY16&index=12) described in http://doi.org/10.1002/rcs.2053,
4+
at the University of Tokyo.
5+
It has then been used in dozens of projects and updated in http://doi.org/10.1109/MRA.2023.3336472 for the [AI Science Platform](https://www.youtube.com/watch?v=3JPSywPAdj4). Please cite one
6+
of these references if you use `sas` in your own work.
7+
8+
::::{grid} 1 1 2 3
9+
10+
:::{card}
11+
:header: Focus on your application🔍
12+
`sas` is a C++ framework with Python bindings to enable fast prototyping using `ROS 2`
13+
toolchain.
14+
:::
15+
16+
:::{card}
17+
:header: `ROS 2` where it shines✨
18+
Split away `ROS 2` code into `client` and `server` classes, communicate via `ROS 2`
19+
without `ROS 2` code.
20+
:::
21+
22+
:::{card}
23+
:header: Multiple robots🤖
24+
Enjoy drivers for `DensoWave`, `UR`, and `KUKA`. With ongoing developments for `Franka Emika`
25+
and `Unitree` robots.
26+
:::
27+
::::
28+
29+
Please note that `sas` is originally based on developments [circa 2013](https://github.com/rosilo) by Murilo M. Marinho.
30+
Affiliation with the University of Tokyo has ceased on December 2023 and this project is currently affiliated with
31+
the University of Manchester.
532

633
## Quickstart
734

@@ -41,7 +68,7 @@ sudo apt-get install libdqrobotics libdqrobotics-interface-json11 libdqrobotics-
4168
##### Python
4269
4370
:::{important}
44-
Because ROS2 does not currently support `venv`, it is recommended
71+
Because `ROS 2` does not currently support `venv`, it is recommended
4572
to install this system-wide.
4673
:::
4774
@@ -50,8 +77,6 @@ python3 -m pip install dqrobotics --pre --break-system-packages
5077
:::
5178
5279
```
53-
54-
5580
The command below will add and install the `sas` packages via `apt-get`.
5681

5782
```bash
@@ -64,14 +89,16 @@ sudo apt update
6489
sudo apt-get install ros-jazzy-sas-*
6590
```
6691

67-
> [!NOTE]
68-
> After installing the packages with the command above, you can update them with
69-
> ```bash
70-
> sudo apt-get update && sudo apt-get upgrade ros-jazzy-sas-*
71-
> ```
72-
92+
```{note}
93+
:class: dropdown
94+
# Click here for update instructions.
95+
After installing the packages with the command above, you can update them with
96+
:::bash
97+
sudo apt-get update && sudo apt-get upgrade ros-jazzy-sas-*
98+
:::
99+
```
73100

74-
## Overview
101+
## License
75102

76103
```{figure} img/computer_ros2.png
77104
:label: sas_and_ros2
@@ -81,40 +108,11 @@ sudo apt-get install ros-jazzy-sas-*
81108
SAS and ROS2
82109
```
83110

84-
::::{grid} 1 1 2 3
85-
86-
:::{card}
87-
:header: Focus on your application🔍
88-
`SAS` is a C++ framework with Python bindings to enable fast prototyping on ROS 2.
89-
:::
90-
91-
:::{card}
92-
:header: `ROS2` where it shines✨
93-
Split away `ROS 2` code into `client` and `server` classes, communicate via `ROS 2`
94-
without `ROS 2` code.
95-
:::
96-
97-
:::{card}
98-
:header: Multiple robots🤖
99-
Enjoy drivers for `DensoWave`, `UR`, and `KUKA`. With ongoing developments for `Franka Emika`
100-
and `Unitree` robots.
101-
:::
102-
::::
103-
104-
111+
`sas` has worked in a dual-licensing scheme, described in the dropdown boxes below.
105112

106-
107-
The SmartArmStack has been developed in support of the SmartArm robot described in http://doi.org/10.1002/rcs.2053.
108-
It has then been used in dozens of publications and updated in http://doi.org/10.1109/MRA.2023.3336472. Please cite one
109-
of these references if you use `SAS` in your own work.
110-
111-
## License
112-
113-
Most of the library is licensed in LGPLv3. Some packages are licensed as Research Only, with no commercial use allowed.
114-
115-
## Package Summary
116-
117-
### LGPL
113+
```{important}
114+
:class: dropdown
115+
### Click here for the LGPL packages information
118116
119117
| Package | License | Description |
120118
|--------------------------|---------|--------------------------------------------------------------------------------------------------------------------------|
@@ -127,6 +125,14 @@ Most of the library is licensed in LGPLv3. Some packages are licensed as Researc
127125
| `sas_robot_driver_denso` | LGPL | A `sas_robot_driver` implementation for DensoWave's bCap controlled robots |
128126
| `sas_robot_driver_kuka` | LGPL | A `sas_robot_driver` implementation for Kuka (Sunrise cabinet, FRI) |
129127
| `sas_robot_driver_ur` | LGPL | A `sas_robot_driver` implementation for UR |
128+
```
129+
130+
```{tip}
131+
:class: dropdown
132+
### Click here for the Noncommercial packages information
133+
134+
Currently being ported and packaged to `ROS 2` jazzy.
135+
```
130136

131137
## Tutorials
132138

0 commit comments

Comments
 (0)