Blame view

README.md 7.52 KB
b8064570   Etienne Pallier   better formatted ...
1
# PYROS (PYthon Robotic telescope Operating Software)
0295ca78   Etienne Pallier   README update for...
2
A Python software for the management of a Telescope control center
e401257c   Etienne Pallier   README with miles...
3

f946c501   Etienne Pallier   updated readme
4
COPYRIGHT (C) 2012-2018 IRAP (Institut de Recherche en Astrophysique et Planetologie) Toulouse - France
6bbc662a   Etienne Pallier   ignore .project a...
5

b8064570   Etienne Pallier   better formatted ...
6
Authors : etienne.pallier@irap.omp.eu, alain.klotz@irap.omp.eu, patrick.maeght@irap.omp.eu, paul.carensac@epitech.eu, alexandru.burlacu11@gmail.com, jeremy.barneron@gmail.com, quentin.durand@epitech.eu
e401257c   Etienne Pallier   README with miles...
7

0295ca78   Etienne Pallier   README update for...
8
9
GPL License (http://www.gnu.org/copyleft/gpl.html) - See the file LICENSE.txt

b8064570   Etienne Pallier   better formatted ...
10
This software runs with Python 3 and Django 2
0295ca78   Etienne Pallier   README update for...
11

b8064570   Etienne Pallier   better formatted ...
12
13
To install it, go into the "install/" folder, and read the document INSTALLATION 
(better is to go to https://docs.google.com/document/d/1m7wUGMUPNPE2gdsQNLILDeF738oIk9OlQjVjNzQyWA8/edit#heading=h.aqi3gs3yp2s3)
0295ca78   Etienne Pallier   README update for...
14

18782713   Etienne Pallier   readme update
15
16
This file is written in the markdown format (see https://openclassrooms.com/en/courses/1304236-redigez-en-markdown, https://michelf.ca/projets/php-markdown/syntaxe, https://daringfireball.net/projects/markdown/syntax)

0295ca78   Etienne Pallier   README update for...
17
-----------------------------------------------------------------------------------------------------------
b8064570   Etienne Pallier   better formatted ...
18
19
## Tested platforms

0295ca78   Etienne Pallier   README update for...
20
21
22
23
24
This software has been tested and validated with the following configurations :

- Centos 7 (test server planetoweb2) :
	- Python: 3.5
	- Mysql:
f1a10cf4   Jeremy   Update readme
25
	- Apache:
0295ca78   Etienne Pallier   README update for...
26
27
28

- Ubuntu 14LTS (Paul Carensac's laptop) :
	- Python: 3.5
eea995c9   haribo   Date: 16/06/2016
29
	- Mysql: 5.5.46
f1a10cf4   Jeremy   Update readme
30
	- Apache:
0295ca78   Etienne Pallier   README update for...
31

257abe9b   Jeremy   Added comments
32
- Ubuntu 16.04 LTS (Jérémy Barneron's laptop) :
f1a10cf4   Jeremy   Update readme
33
34
35
36
37
38
	- Python: 3.5.2
	- Mysql: 5.7.15
	- Apache: 2.4.18
	- Django: 1.10.2

- Mac OS 10.11.4 (Etienne Pallier's laptop)
0295ca78   Etienne Pallier   README update for...
39
40
41
42
	- Python: 3.5
	- XAMPP for OS X 5.6.3, which comes with :
		- MySQL: 5.6.21
		- Apache 2.4.10
f1a10cf4   Jeremy   Update readme
43

e401257c   Etienne Pallier   README with miles...
44
--------------------------------------------------------------------------------------------
b8064570   Etienne Pallier   better formatted ...
45
## Project structure
6bbc662a   Etienne Pallier   ignore .project a...
46
47
48
49
50
51
52

    - src/ : conteneur du projet (le nom est sans importance)
    	- manage.py : utilitaire en ligne de commande permettant differentes actions sur le projet
    	- pyros/ : the actual Python package of the project
    		- settings.py : project settings and configuration
	    	- urls.py : déclaration des URLs du projet
    		- wsgi.py : point d'entrée pour déployer le projet avec WSGI
6bbc662a   Etienne Pallier   ignore .project a...
53
54

	- database/ : database configuration and documentation
f1a10cf4   Jeremy   Update readme
55

6bbc662a   Etienne Pallier   ignore .project a...
56
	- doc/ : project documentation
f1a10cf4   Jeremy   Update readme
57

6bbc662a   Etienne Pallier   ignore .project a...
58
	- install/ : project installation howto
f1a10cf4   Jeremy   Update readme
59

6bbc662a   Etienne Pallier   ignore .project a...
60
	- private/ : the content of this folder is private and thus not commited to git ; it should contain your Python3 virtual environment
ef4dd9e1   Jeremy   Update readme
61
62
	
	- simulators/ : the devices simulators
f1a10cf4   Jeremy   Update readme
63

6bbc662a   Etienne Pallier   ignore .project a...
64
65
	- public/ : this folder contains all public files like the web html files
		- static/
f1a10cf4   Jeremy   Update readme
66

0295ca78   Etienne Pallier   README update for...
67
--------------------------------------------------------------------------------------------
b8064570   Etienne Pallier   better formatted ...
68
69
## LAST VERSION

f49b7078   Etienne Pallier   Bugfix tests and ...
70
Date: 15/10/2018
0295ca78   Etienne Pallier   README update for...
71

7f5ddc07   Etienne Pallier   analysis class ta...
72
By: E. Pallier
b8064570   Etienne Pallier   better formatted ...
73

f49b7078   Etienne Pallier   Bugfix tests and ...
74
VERSION: 20181015.0.011.1 (bugfix)
b8064570   Etienne Pallier   better formatted ...
75

f49b7078   Etienne Pallier   Bugfix tests and ...
76
77
- NEW versionning plan : YYYYMMDD.M.mmm.b
    - YYYYMMDD = Day (UTC)
b8064570   Etienne Pallier   better formatted ...
78
79
80
    - M = Major version number
    - mmm = Minor version number
    - b = Bugfix number
f49b7078   Etienne Pallier   Bugfix tests and ...
81
82
- Global Version number is now in src/__init__.py (idem for each pyros application) 
- Bugfix tests
11ae0484   Etienne Pallier   New versionning p...
83

b8064570   Etienne Pallier   better formatted ...
84
--------------------------------------------------------------------------------------------
11ae0484   Etienne Pallier   New versionning p...
85
86
87
- TECHNICAL DOC: tinyurl/pyros-colibri
- DEV PLAN: https://docs.google.com/spreadsheets/d/1Gy6c-9fhUDBx5Bc6YrcGvfgP-HukWdhUh8oT11_y88g/edit#gid=664458270 
- (OLD, TO BE UPDATED) https://projects.irap.omp.eu/versions/158
b8064570   Etienne Pallier   better formatted ...
88
- ROADMAP (OLDish): https://projects.irap.omp.eu/projects/pyros/roadmap
bb45cd4a   haribo   Date: 25/05/2016
89

e401257c   Etienne Pallier   README with miles...
90
--------------------------------------------------------------------------------------------
eea995c9   haribo   Date: 16/06/2016
91

b8064570   Etienne Pallier   better formatted ...
92
93
94
**IF EVER STRUCTURAL MODIFICATIONS NEED TO BE DONE MANUALLY AFTER UPDATE (git pull)** :

=> re-execute the installation script (python3 install.py update)
eea995c9   haribo   Date: 16/06/2016
95
96

--------------------------------------------------------------------------------------------
b8064570   Etienne Pallier   better formatted ...
97
## MAIN CHANGES (MILESTONES):
e401257c   Etienne Pallier   README with miles...
98

0295ca78   Etienne Pallier   README update for...
99
Full list of commits: https://gitlab.irap.omp.eu/epallier/pyros/commits/master
e401257c   Etienne Pallier   README with miles...
100

b8064570   Etienne Pallier   better formatted ...
101
**10/10/18 : Version 2018.0.011 (E. Pallier)**
f49b7078   Etienne Pallier   Bugfix tests and ...
102
103
- NEW versionning plan : YYYYMMDD.M.mmm.b
    - YYYYMMDD = Day (UTC)
b8064570   Etienne Pallier   better formatted ...
104
105
106
107
108
109
110
111
112
    - M = Major version number
    - mmm = Minor version number
    - b = Bugfix number
- new devices_channel/ folder containing the new DeviceControllerAbstract and ClientChannelAbstract classes (independant from pyros for the moment, but will soon be integrated)
- new src/utils/celme (celestial mecanics) library from Alain Klotz (more and more used inside pyros)
- better README.md formatted file

**14/05/18 : Version 2018.0.001 (Q. Durand)**
- Update all dependencies, update to django 2 and work in progress on the dashboard
e573c1f1   Etienne Pallier   All unit tests no...
113

b8064570   Etienne Pallier   better formatted ...
114
115
**23/03/18	Version 0.16.11 (E. Pallier)**
- All unit tests now pass WITHOUT celery (./manage.py test or ./pyros.py test)
e573c1f1   Etienne Pallier   All unit tests no...
116

b8064570   Etienne Pallier   better formatted ...
117
118
**22/03/18	Version 0.16.10 (E. Pallier)**
- New global variable USE_CELERY (false by default) in pyros.settings
552f1515   Etienne Pallier   New global variab...
119

b8064570   Etienne Pallier   better formatted ...
120
121
122
**13/03/18	Version 0.16.7 (E. Pallier)**
- Each agent (envmonitor, majordome, alert) can be started independently with a script (new script start_agent in each agent directory)
- New command "pyros start" to start pyros in different ways (different options : everything or only some components)
b4e8963c   Etienne Pallier   Each agent (envmo...
123

b8064570   Etienne Pallier   better formatted ...
124
125
**22/02/18	Version 0.16.5 (E. Pallier)**
- Better isolation of Monitoring for easier testing (+ tuto)
c7583f6e   Etienne Pallier   Cleaner isolation...
126

b8064570   Etienne Pallier   better formatted ...
127
128
**01/02/18	Version 0.16.3 (Q. Durand)**
- New installation script src/install/install.py multiplatform (Lin-Mac-Win10, but also tested on Win7)
7f83556a   Etienne Pallier   updated README
129
			
b8064570   Etienne Pallier   better formatted ...
130
131
132
**24/02/17    Version 0.15.1 - Added comments (Jeremy Barneron)**
- Details added to describe the functions behavior
- https://projects.irap.omp.eu/versions/158
257abe9b   Jeremy   Added comments
133

b8064570   Etienne Pallier   better formatted ...
134
135
136
**18/01/17    Version 0.15 - Execution with simulators**
- Simulators evolution / majordome / monitoring / installer
- https://projects.irap.omp.eu/versions/158
ef4dd9e1   Jeremy   Update readme
137

b8064570   Etienne Pallier   better formatted ...
138
139
140
**15/12/16    Version 0.14.1 - Final version 0.14**
- Scenarist first versions
- https://projects.irap.omp.eu/versions/152
53787d30   Jeremy   Alert now inherit...
141

552f1515   Etienne Pallier   New global variab...
142
02/08/16	Version 0.12.4 - Final version 0.12
db882807   haribo   Date: 02/08/2016
143
144
145
			Simulators first versions
			https://projects.irap.omp.eu/versions/129

552f1515   Etienne Pallier   New global variab...
146
20/07/16	Version 0.11.4 - Final version 0.11
ac26ad2b   haribo   Date: 22/07/2016
147
148
149
			Alert manager second version
			https://projects.irap.omp.eu/versions/128

552f1515   Etienne Pallier   New global variab...
150
05/07/16	Version 0.10.2 - Final version 0.10
2ceea892   haribo   Date: 19/07/2016
151
152
153
			Monitoring first version
			https://projects.irap.omp.eu/versions/120

552f1515   Etienne Pallier   New global variab...
154
05/07/16	Version 0.9.2 - Final version 0.9
288601ca   haribo   Date: 05/07/2016
155
156
157
			Analysis skeleton
			https://projects.irap.omp.eu/versions/119

552f1515   Etienne Pallier   New global variab...
158
28/06/16	Version 0.8.3 - Final version 0.8
288601ca   haribo   Date: 05/07/2016
159
			Execution (majordome & obs manager), first version
5d61cbfe   haribo   Just adding / rem...
160
161
			https://projects.irap.omp.eu/versions/118

7f83556a   Etienne Pallier   updated README
162
23/06/16		Version 0.7.8 - Final version 0.7
9f81217f   haribo   Date: 22/06/2016
163
164
165
			Routine manager, first version
			https://projects.irap.omp.eu/versions/117

7f83556a   Etienne Pallier   updated README
166
20/05/16		Version 0.6.1 - Final version 0.6
bbf6e698   haribo   Date: 14/06/2016
167
168
169
			Complete user management
			https://projects.irap.omp.eu/versions/123

7f83556a   Etienne Pallier   updated README
170
20/05/16		Version 0.5.4 - Final version 0.5
bbf6e698   haribo   Date: 14/06/2016
171
172
173
			Complete alert manager first version
			https://projects.irap.omp.eu/versions/116

7f83556a   Etienne Pallier   updated README
174
20/05/16		Version 0.4.2 - Final version 0.4
a2283bf3   haribo   Date: 20/05/2016
175
176
177
			Complete scheduler update
			https://projects.irap.omp.eu/versions/90

7f83556a   Etienne Pallier   updated README
178
10/05/16		Version 0.3.12 - Final version 0.3
0295ca78   Etienne Pallier   README update for...
179
180
			Complete workflow skeleton
			https://projects.irap.omp.eu/versions/88
9d8a01e0   Etienne Pallier   updated
181

7f83556a   Etienne Pallier   updated README
182
13/04/16		Version 0.2.7 - Final version 0.2
0295ca78   Etienne Pallier   README update for...
183
184
			Integrate PLANNER module
			https://projects.irap.omp.eu/versions/97
c668c248   haribo   Updated README wi...
185

7f83556a   Etienne Pallier   updated README
186
12/04/16		Version 0.1.1 - Final version 0.1
9d8a01e0   Etienne Pallier   updated
187
188
			Multi-platform skeleton easy install + admin interface on database + start dashboard
			https://projects.irap.omp.eu/versions/87
e401257c   Etienne Pallier   README with miles...
189

e401257c   Etienne Pallier   README with miles...
190
04/04/16 	Installable version (install script)
f49b7078   Etienne Pallier   Bugfix tests and ...
191
192
193
194
195
196
197
198
199
200
201
202
203


--------------------------------------------------------------------------------------------
## TODO LIST (URGENT)

DEMO:
- SIMULATOR: 
    - (AC) réserver cette page à un login superuser sinon n'importe qui pourra faire n'importe quoi à distance...
    - 1) PLC : 
        - ajouter boutons "START" et "STOP"
        - implémenter weather et site OK/KO
    - 2) TELE : implémenter "start" et "stop"
    - 3) General : implement set to night/day