|
1 | 1 | # 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. |
3 | 3 |
|
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) |
7 | 5 |
|
8 | 6 |  |
| 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 |
9 | 14 |
|
10 | | -Installation |
| 15 | +## Installation |
| 16 | +Check the requirements, but the following command should install all the packages. |
11 | 17 | ------ |
12 | 18 | Run the following command from root folder: |
13 | 19 | ```sh |
14 | 20 | pip install . |
15 | 21 | ``` |
16 | | -Dependencies: numpy, scipy |
17 | 22 |
|
18 | | -Tests |
| 23 | +## Examples |
| 24 | +------ |
| 25 | +Examples are located in the examples/ folder. At the moment only 1 example is available. |
| 26 | + |
| 27 | +## Tests |
19 | 28 | ------ |
20 | 29 | To execute tests run the following command |
21 | 30 | ```sh |
22 | 31 | python -m unittest |
23 | 32 | ``` |
24 | 33 |
|
25 | | -Examples |
26 | | ------- |
27 | | -Examples are located in the examples/ folder. At the moment only 1 example is available. |
28 | | - |
29 | | -Objectives |
| 34 | +## Changelog |
30 | 35 | ------ |
31 | 36 | - [**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)) |
32 | 37 | - [**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 |
34 | 39 | - [**TODO**] Add MIMO Support |
35 | 40 | - [**TODO**] Add IV Support |
36 | 41 | - [**TODO**] Generalize to other kind of controllers (e.g., neural nets) |
0 commit comments