Skip to content

Commit 2f05e87

Browse files
committed
Update readme
1 parent f1cf3f6 commit 2f05e87

1 file changed

Lines changed: 18 additions & 13 deletions

File tree

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
11
# PythonVRFT Library - Version 0.0.3
2-
VRFT Adaptive Control Library written in Python.
2+
VRFT Adaptive Control Library written in Python. Aim of this library is to provide an implementation of the VRFT (Virtual Reference Feedback Tuning) algorithm.
33

4-
**Author**: Alessio Russo (PhD Student at KTH - alesssior@kth.se)
5-
6-
Aim of this library is to provide an implementation of the VRFT (Virtual Reference Feedback Tuning) algorithm.
4+
_Author_: Alessio Russo (PhD Student at KTH - alesssior@kth.se)
75

86
![alt tag](https://github.com/rssalessio/PythonVRFT/blob/master/examples/1_example.png)
7+
## License
8+
Our code is released under the GPLv3 license (refer to the [LICENSE](https://github.com/rssalessio/PythonVRFT/blob/master/LICENSE) file for details).
9+
10+
## Requirements
11+
- Python 3.9.1
12+
- NumPy 1.19.5
13+
- SciPy 1.6.0
914

10-
Installation
15+
## Installation
16+
Check the requirements, but the following command should install all the packages.
1117
------
1218
Run the following command from root folder:
1319
```sh
1420
pip install .
1521
```
16-
Dependencies: numpy, scipy
1722

18-
Tests
23+
## Examples
24+
------
25+
Examples are located in the examples/ folder. At the moment only 1 example is available.
26+
27+
## Tests
1928
------
2029
To execute tests run the following command
2130
```sh
2231
python -m unittest
2332
```
2433

25-
Examples
26-
------
27-
Examples are located in the examples/ folder. At the moment only 1 example is available.
28-
29-
Objectives
34+
## Changelog
3035
------
3136
- [**DONE - V0.0.2**][26.03.2017] Implement the basic VRFT algorithm (1 DOF. offline, linear controller, controller expressed as scalar product theta*f(z))
3237
- [**DONE - V0.0.3**][05.01.2020] Code refactoring and conversion to Python 3; Removed support for Python Control library.
33-
- [**TODO**] Add Documentation and Latex formulas
38+
- [**In Progress**][07.01.2020-] Add Documentation and Latex formulas
3439
- [**TODO**] Add MIMO Support
3540
- [**TODO**] Add IV Support
3641
- [**TODO**] Generalize to other kind of controllers (e.g., neural nets)

0 commit comments

Comments
 (0)