diff --git a/README.md b/README.md index 45ee287..bb2d068 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -# sunrise +[![License](https://img.shields.io/github/license/18tbr/sunrise)](https://github.com/18tbr/sunrise/blob/master/LICENSE) +![Windows Support](https://img.shields.io/badge/Windows-Support-brightgreen.svg) +![Linux Support](https://img.shields.io/badge/Linux-Support-brightgreen.svg) +![Mines de Paris](https://img.shields.io/badge/Organisme-Mines%20de%20Paris-blue) + +# Mines de Paris - SunRise + +

+ + + +

+ The official repos for the Sunrise project. It was created by fusing several older repos together. -In order to contribute to this repos, please fork and create a pull request, this way I will review your code before merging it. -Also, please put the separate parts of the code in different folder (i.e. the python code in a python folder, the arduino code in an arduino folder etc ...). +In order to contribute to this repos, please fork and create a pull request, this way we will review your code before merging it. +Also, please put the separate parts of the code in different folders (i.e. the python code in a `python` folder, the arduino code in an `arduino` folder, etc...). + +

+ + + +

+ +

+ + + +

diff --git a/assets/logoCES.png b/assets/logoCES.png new file mode 100644 index 0000000..df4b679 Binary files /dev/null and b/assets/logoCES.png differ diff --git a/assets/logoMinesParisTech.png b/assets/logoMinesParisTech.png new file mode 100644 index 0000000..bc5df94 Binary files /dev/null and b/assets/logoMinesParisTech.png differ diff --git a/assets/logoProjet2020.png b/assets/logoProjet2020.png new file mode 100644 index 0000000..a14cd1a Binary files /dev/null and b/assets/logoProjet2020.png differ diff --git a/python/README.md b/python/README.md index 0f0588a..c6c7d7d 100644 --- a/python/README.md +++ b/python/README.md @@ -9,9 +9,7 @@ Math group repository. 1.3. [ Push the codes ](#13-push-the-codes) 2. [ Structure ](#2-structure) 3. [ Coding conventions ](#3-coding-conventions) - 3.1. [ Documenting and commenting ](#31-documenting-and-commenting) -4. [ Tests ](#4-tests) -5. [ Pics ](#5-pics) +4. [ Pics ](#5-pics) ## 1. How to @@ -59,30 +57,12 @@ Don't forget to `git pull` each time you want to work on the codes! - `cable_robot.py`: test script so that the cli.py does not raise an error. - `command.py`: discretization and motors rotation computation, main script, called by `cli.py`; - `modules`: - - `decorators.py`: decorators for a cleaner code, it is ok if you don't look at it; - `objects.py`: classes needed for the `command.py` script; - `utils.py`: tools and mathematical functions used by `command.py`. -- `mathPartie1`: deprecated, was a previous version of `command.py`; -- `groupeMathSquelette`: deprecated, was a previous version of `command.py`; -### 2.1. `cli.py` -To do -### 2.2. `command.py` -To do -### 2.3. `objects.py` -To do -### 2.4. `utils.py` - -We want to compute the number of steps in which we are going to divide each interval of the trajectory. -For each interval, this number is -`max(ceil(L_i/dx_i)_i)` -where `i` in `[|1,6|]` is the dimension, `L_i` is the distance we want to do in the interval and `dx_i` is the maximum step authorized. - ## 3. Coding conventions -### 3.1. Documenting and commenting - When a function is defined, we document it as follows: ```py def fun(arg): @@ -99,15 +79,8 @@ def fun(arg): pass ``` -## 4. Tests - -For now, no unittest has been implemented and the `.py` files in the `test/` folder are empty. -To run the tests, type in a terminal: -```bash -python -m unittest -``` -## 5. Pics +## 4. Pics - motor numbering: diff --git a/python/command.py b/python/command.py index ab814a6..a3ee339 100644 --- a/python/command.py +++ b/python/command.py @@ -12,6 +12,7 @@ [0, 10, 10, 0, 0, 0], [10, 10, 10, 0, 0, 0], [10, 10, 0, 0, 0, 0], + [10, 0, 20, 0, 0, 0], ], dtype=float, ) @@ -27,4 +28,4 @@ # mobile.position = emplacement # print(mobile) - traj.animate(save=False) + traj.animate(save=True)