Skip to content

Commit 31c934a

Browse files
author
Murilo Marinho
committed
Basic functionalities
1 parent e701350 commit 31c934a

19 files changed

+66
-12963
lines changed

CHANGELOG.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## 2025
44

5-
- I'm removing `spatialmath` from the tutorials and moving any old content to `legacy/spatialmath`. The original intention when adding this library was to facilitate more complex content in later parts of the module. With variable levels of programming knowledge in the standard cohort this is not possible, and the following issues were observed:
6-
- `spatialmath` not being available as binary package in many distributions, causing students to have to compile the `wheel` even when using `pip`.
7-
- In Windows enviroments, for example, this means having a working VS Compiler installation which is not default and is beyond the scope of this module.
8-
- In any distribution, this could take several minutes and even fail depending on student's enviroments.
9-
- Students tend to default to memorising the library functions instead of understanding the underlying mechanism, irrespective of how trivial the operations are. It is more pedagogical to rely on the matricial operations that they are expected to learn and reinforce that knowledge.
5+
- I've moved this to `mystmd` from the previous version kindly made by [juanjqo](https://github.com/juanjqo). I will try to keep the images alive
6+
as much as possible.
107

11-
- Remove all mentions of `import` in sample code, and keep them to explicit and isolated import cells. Despite the clear indication in the text that the `import` statement was merely illustrative, novice readers often default to copying and pasting chunks of example code causing extraneous `import` statements that result in unprofessional code that, beyond aesthetics, can cause all sorts of issues.
8+
## History
9+
10+
Previous versions of this library and website were made while I was a student or employed at the University of Tokyo. Very early
11+
versions of this were made while I was a student at the University of Brasilia.

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
1-
# SmartArmStack.github.io
1+
# SAS
2+
3+
## Quickstart
4+
5+
```commandline
6+
TODO
7+
```
8+
9+
## A quick note
10+
11+
If being read on GitHub, please note that this page is better seen at https://smartarmstack.github.io.
12+
13+
## Overview
14+
15+
```{image} img/computer_ros2.svg
16+
:width: 300px
17+
:align: left
18+
```
19+
20+
The SmartArmStack has been developed in support of the SmartArm robot described in http://doi.org/10.1002/rcs.2053.
21+
It has then been used in dozens of publications and updated in http://doi.org/10.1109/MRA.2023.3336472. Please cite one
22+
of these references if you use `SAS` in your own work.
23+
24+
The current version of `SAS` supports `ROS 2`.
25+
26+
## About
27+
28+
`SAS` is a C++ framework with Python bindings to enable fast prototyping on ROS 2. Focus on your application.
29+
The concept of `SAS` is to split away `ROS 2` code into `client` and `server` classes, allowing your code to use
30+
`ROS 2` interfaces without any need to create `publishers` or `subscribers` manually.
31+
32+
## License
33+
34+
Most of the library is licensed in LGPLv3. Some packages are licensed as Research Only, with no commercial use allowed.
35+
36+
## Installation instructions and Tutorials
37+
38+
Please refer to https://ros2-tutorial.readthedocs.io/en/latest/sas/index.html.
39+
40+
## Dependencies
41+
42+
```{image} img/computer_capi_open_tech.svg
43+
:width: 300px
44+
:align: left
45+
```
46+
47+
The main dependencies to note are [ros2](https://www.ros.org), [dqrobotics](https://dqrobotics.github.io), [eigen3](https://eigen.tuxfamily.org/index.php?title=Main_Page), and [pybind11](https://pybind11.readthedocs.io/en/stable/).
48+

book.md

Lines changed: 0 additions & 123 deletions
This file was deleted.

build_html.sh

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,8 @@
44
python -m pip install jupyter-book --pre
55

66
# Otherwise the links will not be correctly set up for th webpage
7-
export BASE_URL="https://marinholab.github.io/OpenExecutableBooksRobotics"
7+
export BASE_URL="https://smartarmstack.github.io"
88

9-
# This is a bit hacky.
10-
# https://github.com/orgs/jupyter-book/discussions/2055#discussioncomment-13250715
11-
# This is my temporary hacky solution
12-
13-
# Run once without the devel
14-
cp myst.yml _myst.yml
15-
sed -i.bak '/\#USING DQROBOTICS DEVEL \[START\]/,/\#USING DQROBOTICS DEVEL \[END\]/d' myst.yml
16-
echo "RUN ONE, WITHOUT DQROBOTICS DEVEL PAGES"
17-
cat myst.yml
18-
python -m jupyter book build --html --execute
19-
20-
# Run again with the devel. The cached should no longer collide
21-
mv _myst.yml myst.yml
22-
python -m jupyter book build --html --execute
23-
echo "RUN TWO, WITH DQROBOTICS DEVEL PAGES"
24-
cat myst.yml
9+
# Build page
10+
python -m jupyter book build --html
2511

img/docusaurus-social-card.jpg

-54.4 KB
Binary file not shown.

img/docusaurus.png

-5.02 KB
Binary file not shown.

img/favicon.ico

-3.54 KB
Binary file not shown.

img/logo.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)