Skip to content

Commit 24f7dc9

Browse files
author
Murilo Marinho
committed
[index] Adding index page to the basic lessons.
1 parent ee6dd85 commit 24f7dc9

7 files changed

Lines changed: 52 additions & 7 deletions

File tree

.github/workflows/notebook_to_html.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ jobs:
3030

3131
# Steps represent a sequence of tasks that will be executed as part of the job
3232
steps:
33-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
33+
# Checks out your repository under $GITHUB_WORKSPACE, so your job can access it
3434
- uses: actions/checkout@v4
3535

36-
# Runs a set of commands using the runners shell
36+
# Runs a set of commands using the runner's shell
3737
# https://mystmd.org/guide/deployment-github-pages#fn-except-custom-domains
3838
- name: Install dependencies and build page
3939
run: |

basic_lessons/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Introduction
3+
...
4+
5+
## Description
6+
7+
In this five-lesson tutorial, we start from the very basics of scalar and matricial operations in Python using `numpy`,
8+
all the way until the basics of kinematic control. Until kinematic control, most is based on [@spong2020robot].
9+
10+
# Using this book
11+
12+
Each lesson is a [Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html). Each lesson can be
13+
opened and executed with popular IDEs, such as [VSCode](https://code.visualstudio.com) and [PyCharm](https://www.jetbrains.com/pycharm/).
14+
The reader is expected to follow it sequentially.
15+
16+
# Table of Contents
17+
18+
- [](./lesson1_tutorial.ipynb) \
19+
Basic operations in Python and `numpy`.
20+
21+
- [](./lesson2_tutorial.ipynb) \
22+
Learn about elements and operations in $\mathbb{R}^n$, $SO(n)$, and $SE(n)$ with $n\in{\{2,3\}}$ related to positions,
23+
orientations, and poses, respectively.
24+
25+
- [](./lesson3_tutorial.ipynb) \
26+
Learn about the composition of rigid body motion in series to obtain the forward kinematics model of a robotic manipulator,
27+
mapping their configuration space $\myvec{q}\in\mathbb{R}^n$ into their task space $\myvec{x}\in\mathbb{R}^m$.
28+
29+
- [](./lesson4_tutorial.ipynb) \
30+
Learn about the first-order differential mapping $\dot{\myvec{x}}=\mymatrix{J}\dot{\myvec{q}}$ between joint space and
31+
task space velocities through the calculation of the Jacobian $\mymatrix{J}$.
32+
33+
- [](./lesson5_tutorial.ipynb) \
34+
Employ the previous knowledge in all previous lessons to employ a Lyapunov-stable control law to move a manipulator
35+
in task space using configuration-space signals.

basic_lessons/lesson4_tutorial.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159
"\n",
160160
"## Step 2: Calculate the differential kinematics by hand\n",
161161
"\n",
162-
"We first calculate the Jacobian by hand, because programatically there's nothing for you to do yet. \n",
162+
"We first calculate the Jacobian by hand, because programmatically there's nothing for you to do yet.\n",
163163
"\n",
164164
"The analytical Jacobian is given by\n",
165165
"\n",

basic_lessons/lesson5_tutorial.ipynb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,8 @@
4848
"outputs": [],
4949
"source": [
5050
"%%capture\n",
51-
"%pip install numpy\n",
52-
"%pip install numpy --break-system-packages\n",
53-
"%pip install matplotlib\n",
54-
"%pip install matplotlib --break-system-packages"
51+
"%pip install numpy matplotlib\n",
52+
"%pip install numpy matplotlib --break-system-packages"
5553
]
5654
},
5755
{

conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
2+
myst_enable_extensions = [
3+
"dollarmath"
4+
]

myst.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ project:
3333
- file: README.md
3434
- title: "[Basic] Robotics using numpy"
3535
children:
36+
- file: basic_lessons/README.md
3637
- file: basic_lessons/lesson1_tutorial.ipynb
3738
- file: basic_lessons/lesson2_tutorial.ipynb
3839
- file: basic_lessons/lesson3_tutorial.ipynb
@@ -57,3 +58,4 @@ site:
5758
options:
5859
favicon: favicon.ico
5960
# logo: site_logo.png
61+

references.bib

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@article{spong2020robot,
2+
title={Robot Modeling and Control},
3+
author={Spong, Mark W and Hutchinson, Seth and Vidyasagar, M},
4+
journal={Wiley},
5+
year={2020}
6+
}

0 commit comments

Comments
 (0)