├── .gitignore ├── figures ├── example_pygantt_1.png └── example_pygantt_2.png ├── README.md ├── pygantt.py ├── example_pygantt.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.html 2 | -------------------------------------------------------------------------------- /figures/example_pygantt_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/louis-heraut/pygantt/HEAD/figures/example_pygantt_1.png -------------------------------------------------------------------------------- /figures/example_pygantt_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/louis-heraut/pygantt/HEAD/figures/example_pygantt_2.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pygantt 2 | A convenient but aesthetic way of creating a GANTT chart thanks to Plotly library (especially for everyone who doesn't want to do one). 3 | 4 | But what is a GANNT ? https://en.wikipedia.org/wiki/Gantt_chart 5 | And what Plotly currently offer : https://plotly.com/python/gantt/ 6 | 7 | To start a new Gantt use the pygantt.py file. Otherwise an example python file is present to generate the example html output. 8 | Here is a general preview of the example_pygantt.html file :
9 | [](https://htmlpreview.github.io/?https://github.com/super-lou/pygantt/blob/4a746c2b89f29a4d3c593605042179e9319f9e5e/example_pygantt.html)
10 | 11 | And a zoom view of the hover info possible :
12 |
13 | 14 | Have fun. 15 | -------------------------------------------------------------------------------- /pygantt.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2021 Louis Héraut, Louis Gostiaux 3 | 4 | This file is part of Pygantt. 5 | 6 | Pygantt is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pygantt is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pygantt. If not, see . 18 | 19 | /\ /\ 20 | = 0 0 = 21 | """"""""" 22 | 23 | ### 1. LIBRARY 24 | import plotly.graph_objects as go 25 | import pandas as pd 26 | import datetime 27 | import numpy as np 28 | 29 | 30 | ### 2. GENERAL INFORMATIONS 31 | ## 2.1. date time info 32 | start = datetime.datetime.strptime("01-04-2021", "%d-%m-%Y") 33 | end = datetime.datetime.strptime("31-07-2021", "%d-%m-%Y") 34 | date_generated = [start + datetime.timedelta(days=x) for x in range(0, (end-start).days, 7)] 35 | 36 | ## 2.2. colors by category 37 | Ccolor = {"Category 1":['LightGreen', 'MediumSeaGreen'], 38 | "Category 2":['LightSkyBlue', 'SteelBlue'], 39 | "Category 3":['PaleVioletRed', 'MediumVioletRed '], 40 | "Category 4":['Plum', 'Orchid'], 41 | "Category 5":['Tan', 'Sienna'], 42 | "Title":['black', 'black'] 43 | } 44 | 45 | 46 | ### 3. CONTENT 47 | odf = pd.DataFrame([ 48 | # section 49 | dict(Task="1. Section", 50 | Start='01-07-2021', Finish='01-07-2021', Completion_pct=0, 51 | Category="Title", 52 | Note=''), 53 | 54 | # subsection 55 | dict(Task="1.1 Subsection 1", 56 | Start='01-07-2021', Finish='10-07-2021', Completion_pct=100, 57 | Category="Category 1", 58 | Note="foo"), 59 | 60 | dict(Task="1.2 Subsection 2", 61 | Start='08-07-2021', Finish='20-07-2021', Completion_pct=60, 62 | Category="Category 2", 63 | Note="foo
" 64 | "foobar
" 65 | "foooobar
"), 66 | # ... 67 | ]) 68 | 69 | 70 | ### 4. DATA PROCESSING 71 | df = odf.copy() 72 | df["Start"] = pd.to_datetime(df["Start"], format="%d-%m-%Y") 73 | df["Finish"] = pd.to_datetime(df["Finish"], format="%d-%m-%Y") 74 | df["Completion_date"] = pd.to_datetime((df["Finish"] - df["Start"]) * df["Completion_pct"] / 100 + df["Start"], format="%d-%m-%Y") 75 | df["Duration"] = (df["Finish"] - df["Start"]) 76 | 77 | 78 | ### 5. PLOTTING 79 | ## 5.1. bars 80 | fig = go.Figure() 81 | for cat in df['Category']: 82 | sdf = df[df['Category'] == cat] 83 | 84 | # full bar 85 | fig.add_trace(go.Bar(base=sdf["Start"], 86 | x=np.array((sdf["Finish"] - sdf["Start"]))/1E6, 87 | y=sdf["Task"], 88 | orientation='h', 89 | marker_color=Ccolor[cat][0], 90 | marker_line_width=0, 91 | width=0.9, 92 | customdata=odf[odf['Category'] == cat], 93 | hovertemplate='%{customdata[0]}

Du %{customdata[1]} au %{customdata[2]}
Complété à %{customdata[3]} %
Catégorie: %{customdata[4]}
Note: %{customdata[5]}', 94 | showlegend=not(cat in [data['name'] for data in list(fig.data)]), 95 | name=cat, 96 | legendgroup=cat)) 97 | 98 | # completion bar 99 | fig.add_trace(go.Bar(base=sdf["Start"], 100 | x=np.array((sdf["Completion_date"] - sdf["Start"]))/1E6, 101 | y=sdf["Task"], 102 | orientation='h', 103 | marker_color=Ccolor[cat][1], 104 | marker_line_width=0, 105 | width=0.9, 106 | customdata=odf[odf['Category'] == cat], 107 | hovertemplate='%{customdata[0]}

Date: %{customdata[1]} / %{customdata[2]}
Complété à: %{customdata[3]} %
Catégorie: %{customdata[4]}
Note: %{customdata[5]}', 108 | legendgroup=cat, 109 | showlegend=False 110 | )) 111 | 112 | # text bar 113 | fig.add_trace(go.Bar(base=sdf["Start"], 114 | x=np.array((sdf["Finish"] - sdf["Start"]))/1E6, 115 | y=sdf["Task"], 116 | orientation='h', 117 | marker_color='rgba(255, 0, 0, 0)', 118 | marker_line_width=0, 119 | width=0.9, 120 | text=sdf["Completion_pct"], 121 | texttemplate='%{text:.0f} %', 122 | textposition='inside', 123 | insidetextanchor='start', 124 | textfont=dict(color='white', family="Lato", size=20), 125 | hoverinfo='skip', 126 | legendgroup=cat, 127 | showlegend=False 128 | )) 129 | 130 | ## 5.2. other info 131 | # marker for today 132 | today = datetime.datetime.today().strftime("%d-%m-%Y") 133 | fig.add_trace(go.Scatter(x=[pd.to_datetime(today, format="%d-%m-%Y") for i in range(len(df))], 134 | y=df["Task"], 135 | mode='lines', 136 | line=dict(color='Gray', dash='dot', width=1), 137 | hovertemplate="Aujourd'hui: {}".format(today), 138 | name="Aujourd'hui" 139 | )) 140 | 141 | ## 5.3. layout 142 | fig.update_yaxes(autorange="reversed") 143 | 144 | fig.update_xaxes( 145 | type="date", 146 | tickformat="%d %b %Y", 147 | # tickvals = [pd.to_datetime(date.strftime("%d-%m-%Y"), format="%d-%m-%Y") for date in date_generated], 148 | range=(pd.to_datetime('01-04-2021', format="%d-%m-%Y"), pd.to_datetime('31-07-2021', format="%d-%m-%Y")), 149 | tickfont=dict(size=13, family="Lato"), 150 | showline=True, 151 | linewidth=2, 152 | linecolor='SlateGrey', 153 | showgrid=True, 154 | gridcolor='LightGrey', 155 | gridwidth=0.5, 156 | ticks="outside", 157 | tickcolor='SlateGrey', 158 | ticklen=4, 159 | tickwidth=2, 160 | tickangle=0, 161 | ticklabelmode='period', 162 | nticks=12 163 | ) 164 | 165 | fig.update_xaxes( 166 | rangeslider_visible=True, 167 | rangeselector=dict( 168 | buttons=list([ 169 | dict(count=7, label="1 semaine", step="day", stepmode="backward"), 170 | dict(count=14, label="2 semaine", step="day", stepmode="backward"), 171 | dict(count=1, label="1 mois", step="month", stepmode="backward"), 172 | dict(label="toute la période", step="all") 173 | ])), 174 | tickformatstops = [ 175 | dict(dtickrange=[None, 86400000], value="%e %b"), 176 | dict(dtickrange=[86400000, 604800000], value="sem. %W"), 177 | dict(dtickrange=[604800000, None], value="%b %Y"), 178 | ] 179 | ) 180 | 181 | fig.update_yaxes( 182 | title='', 183 | tickfont=dict(size=13, family="Lato"), 184 | type='category', 185 | categoryorder='category ascending', 186 | showline=True, 187 | linewidth=2, 188 | linecolor='SlateGrey', 189 | ticks="outside", 190 | tickcolor='SlateGrey', 191 | ticklen=4, 192 | tickwidth=2, 193 | fixedrange=True 194 | ) 195 | 196 | fig.update_layout( 197 | title={'text': "Avancement du stage de Louis Héraut encadré par Louis Gostiaux
Séries temporelles de température dans l'océan profond: ré-analyse des données haute résolution de thermistors NIOZ-HST sur la
période 2006-2016 visant à l'étude des statistiques d'ordre élevé dans les écoulements géophysiques avec rotation et stratification", 198 | 'font':dict(size=18), 199 | 'y':0.96, 200 | 'x':0.085}, 201 | barmode='overlay', 202 | margin=dict(l=80, r=10, t=140, b=60), 203 | plot_bgcolor='white', 204 | height=1100, 205 | width=1300) 206 | 207 | # plotting 208 | fig.write_html("pygantt.html") 209 | fig.show() -------------------------------------------------------------------------------- /example_pygantt.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2021 Louis Héraut, Louis Gostiaux 3 | 4 | This file is part of Pygantt. 5 | 6 | Pygantt is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pygantt is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pygantt. If not, see . 18 | 19 | /\ /\ 20 | = 0 0 = 21 | """"""""" 22 | 23 | ### 1. LIBRARY 24 | import plotly.graph_objects as go 25 | import pandas as pd 26 | import datetime 27 | import numpy as np 28 | import os 29 | 30 | 31 | ### 2. GENERAL INFORMATIONS 32 | ## 2.1. date time info 33 | start = datetime.datetime.strptime("01-04-2021", "%d-%m-%Y") 34 | end = datetime.datetime.strptime("31-07-2021", "%d-%m-%Y") 35 | date_generated = [start + datetime.timedelta(days=x) for x in range(0, (end-start).days, 7)] 36 | 37 | ## 2.2. colors by category 38 | Ccolor = {"Développement d'outil de visualisation":['LightGreen', 'MediumSeaGreen'], 39 | "Développement du traitement de données":['LightSkyBlue', 'SteelBlue'], 40 | "Prise en main du code initial":['PaleVioletRed', 'MediumVioletRed '], 41 | "Utilisation des outils de réseau":['Plum', 'Orchid'], 42 | "Rédaction de contenu scientifique":['Tan', 'Sienna'], 43 | "Titre":['black', 'black'] 44 | } 45 | 46 | 47 | ### 3. CONTENT 48 | odf = pd.DataFrame([ 49 | # section 50 | dict(Task="1. Prise en main de l'environnement de travail", 51 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 52 | Category="Titre", 53 | Note=''), 54 | 55 | # subsection 56 | dict(Task="1.1 Prise en main de git", 57 | Start='01-04-2021', Finish='02-04-2021', Completion_pct=100, 58 | Category="Utilisation des outils de réseau", 59 | Note="Téléchargement du code."), 60 | 61 | dict(Task="1.2 Prise en main du jeu de données du Great Meteor Seamont", 62 | Start='01-04-2021', Finish='02-04-2021', Completion_pct=100, 63 | Category="Prise en main du code initial", 64 | Note="Téléchargement d'un jeu de données légé mais présentant de
" 65 | "nombreux problèmes de déviation."), 66 | 67 | dict(Task="1.3 Reproduction et étude de figure d'article", 68 | Start='02-04-2021', Finish='03-04-2021', Completion_pct=100, 69 | Category="Prise en main du code initial", 70 | Note="figure 3 de van Haren, H., Laan, M., Buijsman, D. J., Gostiaux
" 71 | "L., Smit, M. G., & Keijzer, E. (2009). NIOZ3: Independent
" 72 | "temperature sensors sampling yearlong data at a rate of 1 Hz.
" 73 | "IEEE Journal of Oceanic Engineering, 34(3), 315-322."), 74 | 75 | dict(Task="1.4 Recherche d'une nouvelle interface de code", 76 | Start='06-04-2021', Finish='07-04-2021', Completion_pct=75, 77 | Category="Prise en main du code initial", 78 | Note="Essaie de Visual Studio Code avant de retourner à Pyzo."), 79 | 80 | dict(Task="1.4 Recherche d'une nouvelle interface de code", 81 | Start='14-04-2021', Finish='15-04-2021', Completion_pct=50, 82 | Category="Prise en main du code initial", 83 | Note="Nouvel essaie de configuration de Visual Studio Code avant de
" 84 | "retourner à Pyzo."), 85 | 86 | dict(Task="1.5 Configuration du VPN et de l'accès au calculateur de l'ECL", 87 | Start='02-04-2021', Finish='10-04-2021', Completion_pct=100, 88 | Category="Utilisation des outils de réseau", 89 | Note="Problème de configuration du VPN sur KDE donc aide avec le
" 90 | "responsable informatique du calculateur et formation de groupe
" 91 | "à l'accès au calculateur."), 92 | 93 | 94 | dict(Task="2. Développement de l'espace de travail", 95 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 96 | Category="Titre", 97 | Note=''), 98 | 99 | dict(Task="2.1 Création du schéma d'arboressence de stockage des résultats", 100 | Start='06-04-2021', Finish='10-04-2021', Completion_pct=100, 101 | Category="Développement du traitement de données", 102 | Note="Les informations de calibraions sont stockées dans le noms de fichier
" 103 | "et les noms de dossiers."), 104 | 105 | dict(Task="2.2 Développement du système de processing", 106 | Start='06-04-2021', Finish='14-04-2021', Completion_pct=100, 107 | Category="Développement du traitement de données", 108 | Note="Définiton d'une plage de temps prenant en compte l'ensemble des
" 109 | "données disponibles et test des diverses fonctions d'autoscale."), 110 | 111 | dict(Task="2.3 Développement du système de plotting", 112 | Start='06-04-2021', Finish='12-04-2021', Completion_pct=100, 113 | Category="Développement d'outil de visualisation", 114 | Note="Mise en forme des profils de température, du profil du gradient
" 115 | "vertical et horizontal de température et des profils intermédiaires
" 116 | "entre deux autoscaling adjacents."), 117 | 118 | dict(Task="2.4 Matrice de diagnostique de l'efficacité de la correction", 119 | Start='12-04-2021', Finish='14-04-2021', Completion_pct=75, 120 | Category="Développement d'outil de visualisation", 121 | Note="Diagnostique de vérification de l'effet de l'autoscaling sur la
" 122 | "moyenne et l'écart-type d'un ensemble de température."), 123 | 124 | dict(Task="2.5 Mise au propre général de l'ensemble du code produit", 125 | Start='13-04-2021', Finish='17-04-2021', Completion_pct=100, 126 | Category="Développement du traitement de données", 127 | Note="Louis Gostiaux m'a aidé à remettre en forme l'ensemble du code
" 128 | "pour le rentre d'avantage polyvalent, robuste à l'utilisation en
" 129 | "terminal pour le calculateur et diffusable pour un tier."), 130 | 131 | 132 | dict(Task="3. Développement d'un nouveau moyen d'autoscalling", 133 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 134 | Category="Titre", 135 | Note=''), 136 | 137 | dict(Task="3.1 Autoscalling à variation de température discrete", 138 | Start='19-04-2021', Finish='21-04-2021', Completion_pct=100, 139 | Category="Développement du traitement de données", 140 | Note="En utilisant \Delta T = T_{n} - (T_{n+1} + T_{n-1})/2 sur la
" 141 | "moyenne temporelle des températures de chaque capteur, il est
" 142 | "possible de compenser à l'ordre 0 les décalges d'un capteur
" 143 | "relativement au autres. Ce même calcul peut être effectué sur
" 144 | "les T à tout temps permettant alors de compenser la déviation
" 145 | "à l'ordre 1 d'un capteur en effectuant une régression linéaire
" 146 | "du nuage de point issu de \Delta T = f(T)."), 147 | 148 | dict(Task="3.2 Autoscalling avec utilisation de splines", 149 | Start='21-04-2021', Finish='27-04-2021', Completion_pct=100, 150 | Category="Développement du traitement de données", 151 | Note="La correction de la déviation à l'ordre 0 est réalisée en
" 152 | "utilisant un spline sur l'ensemle des moyennes temporelles des
" 153 | "capteurs. La correction à l'ordre 1 est réalisée en utilisant un
" 154 | "spline par morceaux afin d'estimer à un temps donnés l'écart de
" 155 | "température entre le spline et les data."), 156 | 157 | dict(Task="3.3 Implémentation de la nouvelle méthode dans le code initial", 158 | Start='28-04-2021', Finish='30-04-2021', Completion_pct=100, 159 | Category="Développement du traitement de données", 160 | Note="Implémentation du code développé dans la librairie initiale
" 161 | "et mise au propre."), 162 | 163 | 164 | dict(Task="4. Mise en forme des résultats pour la diffusion", 165 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 166 | Category="Titre", 167 | Note=''), 168 | 169 | dict(Task="4.1 Exportation des données en hdf5", 170 | Start='27-04-2021', Finish='30-04-2021', Completion_pct=100, 171 | Category="Développement du traitement de données", 172 | Note="Mise en forme des données en une unique matrice en concatenant
" 173 | "l'ensemble des différentes calibrations réalisées à chaque temps" 174 | "et système de vérification de la bonne sauvegarde."), 175 | 176 | dict(Task="4.1 Exportation des données en hdf5", 177 | Start='06-05-2021', Finish='01-06-2021', Completion_pct=100, 178 | Category="Développement du traitement de données", 179 | Note="Remise en forme du système de concatenation pour optimiser le
" 180 | "temps de calcul et la mise en mémoire dans le cas de gros fichier
" 181 | "de données."), 182 | 183 | dict(Task="4.2 Coopération avec un autre stagiaire pour la visualisation", 184 | Start='17-05-2021', Finish='16-07-2021', Completion_pct=90, 185 | Category="Développement d'outil de visualisation", 186 | Note="Un autre stagiaire de l'IRIS est chargé de la représentation
" 187 | "des données calibrées sur mur d'écran. Diverse directive lui ont
" 188 | "été données, des réunions on été réalisés."), 189 | 190 | dict(Task="4.3 Remise en forme de l'arborescence du code", 191 | Start='25-06-2021', Finish='27-06-2021', Completion_pct=100, 192 | Category="Développement du traitement de données", 193 | Note="L'ensemble de l'arborescence du code est revu afin de simplifier
" 194 | "l'interaction avec lui et l'implémentation de nouveaux mouillages."), 195 | 196 | dict(Task="4.4 Mise au propre du code", 197 | Start='26-06-2021', Finish='16-07-2021', Completion_pct=75, 198 | Category="Développement du traitement de données", 199 | Note="Le code est mis au propre, les documentations de fonctions sont
" 200 | "revues et des commentaires sont ajoutés. Enfin, des sorties
" 201 | "visuelles de contrôle en ascii art sont aussi développées afin
" 202 | "de pouvoir suivre l'avancé du code et aussi l'état des mouillages."), 203 | 204 | 205 | dict(Task="5. Amélioration de la qualité des résultats de calibration", 206 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 207 | Category="Titre", 208 | Note=''), 209 | 210 | dict(Task="5.1 Mise en forme de résultats de calibration optimaux", 211 | Start='29-04-2021', Finish='15-06-2021', Completion_pct=100, 212 | Category="Développement du traitement de données", 213 | Note="Utilisation du calculateur en faisant varier les différents
" 214 | "paramètres. Les seuils de calibrations sont modifiés, des capteurs
" 215 | "à isoler sont mis en évidence, l'interpolation des données manquantes
" 216 | "est réalisée et diverse remise en forme du code sont réalisés."), 217 | 218 | dict(Task="5.2 Interpolation des calibrations entre chaque plage de temps", 219 | Start='20-05-2021', Finish='08-06-2021', Completion_pct=100, 220 | Category="Développement du traitement de données", 221 | Note="Mise en place d'un système d'interpolation des valeurs de calibration
" 222 | "pour un ensemble de plage de temps défini automatiquement afin de
" 223 | "réduire les problèmes de chevauchements entre calibrations et de
" 224 | "créer des fichiers de calibrations unique pour l'ensemble de la plage
" 225 | "de temps."), 226 | 227 | dict(Task="5.3 Parallélisation avancée du code sur calculateur", 228 | Start='26-05-2021', Finish='29-05-2021', Completion_pct=95, 229 | Category="Développement du traitement de données", 230 | Note="Le nouveau code développé à nécessité une méthode de parallélisation
" 231 | "plus poussée en faisant communiquer les coeurs de calcul entre eux."), 232 | 233 | dict(Task="5.4 Développement d'un nouveau système de visualisation", 234 | Start='27-05-2021', Finish='12-06-2021', Completion_pct=100, 235 | Category="Développement d'outil de visualisation", 236 | Note="Mise en forme d'une visualisation des futurs fichiers de
" 237 | "calibration unique avec une grande superposition entre chaque panel
" 238 | "et ce automatiquement pour différentes plage de temps."), 239 | 240 | dict(Task="5.5 Mise en place d'un système de réduction des artefacts de calibration", 241 | Start='01-06-2021', Finish='11-06-2021', Completion_pct=75, 242 | Category="Développement du traitement de données", 243 | Note="Le sytème de calibration actuel engendre des oscillations de
" 244 | "température entre les capteurs autour de la valeur à priori idéal.
" 245 | "Pondérer la température de référence de la calibration ne résoud
" 246 | "pas ce problème. Cela vient de la correction à l'ordre 0 initiale."), 247 | 248 | dict(Task="5.6 Système de visualisation des données de calibration et loi de calibration", 249 | Start='31-05-2021', Finish='18-06-2021', Completion_pct=100, 250 | Category="Développement d'outil de visualisation", 251 | Note="L'ensemble de données de calibration calculées sont représentées
" 252 | "graphiquement en fonction du temps pour tous les capteurs d'une
" 253 | "plage de temps donnée. Les données binaires de tempérautre sont tracées
" 254 | "en fonction des données calibrées. La différence entre les données
" 255 | "ayant subi un autoscale ou non est étudiée en fonction des données
" 256 | "binaires."), 257 | 258 | dict(Task="5.7 Développement d'une sur couche de traitement", 259 | Start='15-06-2021', Finish='21-06-2021', Completion_pct=100, 260 | Category="Développement du traitement de données", 261 | Note="Afin d'afiner d'avantage la calibration, une sur correction à
" 262 | "l'ordre 0 est mise en place sur des plages de temps plus courtes.
" 263 | "L'architecture du code est revue pour plus de modularité."), 264 | 265 | dict(Task="5.8 Système de d'estimation visuelle d'incertitudes", 266 | Start='11-06-2021', Finish='28-06-2021', Completion_pct=60, 267 | Category="Développement d'outil de visualisation", 268 | Note="La même plage de temps calibrée est représentée avec une échelle
" 269 | "de couleur dont la quantification varie selon plusieurs plannels.
" 270 | "Cela permet de mettre en avant la limite à partir de laquelle la
" 271 | "précision des données peut être remise en cause.
"), 272 | 273 | 274 | dict(Task="6. Mise en place d'un Gantt", 275 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 276 | Category="Titre", 277 | Note=''), 278 | 279 | dict(Task="6.1 Élaboration d'un Gantt à l'aide de Plotly", 280 | Start='18-05-2021', Finish='24-05-2021', Completion_pct=90, 281 | Category="Développement d'outil de visualisation", 282 | Note="L'ensemble de ce Gantt a été codé."), 283 | 284 | dict(Task="6.2 Remplissage du Gantt avec l'état actuel du stage", 285 | Start='20-05-2021', Finish='21-05-2021', Completion_pct=100, 286 | Category="Développement d'outil de visualisation", 287 | Note="Reprise de l'ensemble des notes initalement réalisées sur un fichier
" 288 | "txt et estimation du travail à venir."), 289 | 290 | 291 | dict(Task="7. Réanalyse d'autres jeux de données", 292 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 293 | Category="Titre", 294 | Note=''), 295 | 296 | dict(Task="7.1 Réanalyse des données d'un mouillage de la Fosse Romanche", 297 | Start='21-06-2021', Finish='08-07-2021', Completion_pct=80, 298 | Category="Développement du traitement de données", 299 | Note="Application du système actuel de calibration à un nouveau jeu de
" 300 | "données."), 301 | 302 | dict(Task="7.2 Réanalyse des données d'un mouillage en mer Méditerranée", 303 | Start='08-07-2021', Finish='16-07-2021', Completion_pct=0, 304 | Category="Développement du traitement de données", 305 | Note="Application du système actuel de calibration à un nouveau jeu de
" 306 | "données plus sensible."), 307 | 308 | 309 | dict(Task="8. Rédaction du rapport de stage", 310 | Start='01-04-2021', Finish='01-04-2021', Completion_pct=0, 311 | Category="Titre", 312 | Note=''), 313 | 314 | dict(Task="8.1 Recherche bibliographique", 315 | Start='01-04-2021', Finish='21-07-2021', Completion_pct=30, 316 | Category="Rédaction de contenu scientifique", 317 | Note="Lecture des papiers initiaux de l'offre de stage et ouverture."), 318 | 319 | dict(Task="8.2 Rédaction du rapport de stage à proprement dit", 320 | Start='24-05-2021', Finish='01-08-2021', Completion_pct=20, 321 | Category="Rédaction de contenu scientifique", 322 | Note="Rédaction du maximum de contenu pour le rapport de stage."), 323 | 324 | dict(Task="8.3 Prise de contact avec les différents chercheurs mis en jeu", 325 | Start='21-06-2021', Finish='21-07-2021', Completion_pct=60, 326 | Category="Rédaction de contenu scientifique", 327 | Note="Il serait intéressant de rencontrer Hans van Haren ou encore
" 328 | "Raffaele Marino afin de discuter des possibles retomber de ce
" 329 | "jeux de données."), 330 | 331 | ]) 332 | 333 | 334 | ### 4. DATA PROCESSING 335 | df = odf.copy() 336 | df["Start"] = pd.to_datetime(df["Start"], format="%d-%m-%Y") 337 | df["Finish"] = pd.to_datetime(df["Finish"], format="%d-%m-%Y") 338 | df["Completion_date"] = pd.to_datetime((df["Finish"] - df["Start"]) * df["Completion_pct"] / 100 + df["Start"], format="%d-%m-%Y") 339 | df["Duration"] = (df["Finish"] - df["Start"]) 340 | 341 | 342 | ### 5. PLOTTING 343 | ## 5.1. bars 344 | fig = go.Figure() 345 | for cat in df['Category']: 346 | sdf = df[df['Category'] == cat] 347 | 348 | # full bar 349 | fig.add_trace(go.Bar(base=sdf["Start"], 350 | x=np.array((sdf["Finish"] - sdf["Start"]))/1E6, 351 | y=sdf["Task"], 352 | orientation='h', 353 | marker_color=Ccolor[cat][0], 354 | marker_line_width=0, 355 | width=0.9, 356 | customdata=odf[odf['Category'] == cat], 357 | hovertemplate='%{customdata[0]}

Du %{customdata[1]} au %{customdata[2]}
Complété à %{customdata[3]} %
Catégorie: %{customdata[4]}
Note: %{customdata[5]}', 358 | showlegend=not(cat in [data['name'] for data in list(fig.data)]), 359 | name=cat, 360 | legendgroup=cat)) 361 | 362 | # completion bar 363 | fig.add_trace(go.Bar(base=sdf["Start"], 364 | x=np.array((sdf["Completion_date"] - sdf["Start"]))/1E6, 365 | y=sdf["Task"], 366 | orientation='h', 367 | marker_color=Ccolor[cat][1], 368 | marker_line_width=0, 369 | width=0.9, 370 | customdata=odf[odf['Category'] == cat], 371 | hovertemplate='%{customdata[0]}

Date: %{customdata[1]} / %{customdata[2]}
Complété à: %{customdata[3]} %
Catégorie: %{customdata[4]}
Note: %{customdata[5]}', 372 | legendgroup=cat, 373 | showlegend=False 374 | )) 375 | 376 | # text bar 377 | fig.add_trace(go.Bar(base=sdf["Start"], 378 | x=np.array((sdf["Finish"] - sdf["Start"]))/1E6, 379 | y=sdf["Task"], 380 | orientation='h', 381 | marker_color='rgba(255, 0, 0, 0)', 382 | marker_line_width=0, 383 | width=0.9, 384 | text=sdf["Completion_pct"], 385 | texttemplate='%{text:.0f} %', 386 | textposition='inside', 387 | insidetextanchor='start', 388 | textfont=dict(color='white', family="Lato", size=20), 389 | hoverinfo='skip', 390 | legendgroup=cat, 391 | showlegend=False 392 | )) 393 | 394 | ## 5.2. other info 395 | # marker for today 396 | today = datetime.datetime.today().strftime("%d-%m-%Y") 397 | fig.add_trace(go.Scatter(x=[pd.to_datetime(today, format="%d-%m-%Y") for i in range(len(df))], 398 | y=df["Task"], 399 | mode='lines', 400 | line=dict(color='Gray', dash='dot', width=1), 401 | hovertemplate="Aujourd'hui: {}".format(today), 402 | name="Aujourd'hui" 403 | )) 404 | 405 | ## 5.3. layout 406 | fig.update_yaxes(autorange="reversed") 407 | 408 | fig.update_xaxes( 409 | type="date", 410 | tickformat="%d %b %Y", 411 | # tickvals = [pd.to_datetime(date.strftime("%d-%m-%Y"), format="%d-%m-%Y") for date in date_generated], 412 | range=(pd.to_datetime('01-04-2021', format="%d-%m-%Y"), pd.to_datetime('31-07-2021', format="%d-%m-%Y")), 413 | tickfont=dict(size=13, family="Lato"), 414 | showline=True, 415 | linewidth=2, 416 | linecolor='SlateGrey', 417 | showgrid=True, 418 | gridcolor='LightGrey', 419 | gridwidth=0.5, 420 | ticks="outside", 421 | tickcolor='SlateGrey', 422 | ticklen=4, 423 | tickwidth=2, 424 | tickangle=0, 425 | ticklabelmode='period', 426 | nticks=12 427 | ) 428 | 429 | fig.update_xaxes( 430 | rangeslider_visible=True, 431 | rangeselector=dict( 432 | buttons=list([ 433 | dict(count=7, label="1 semaine", step="day", stepmode="backward"), 434 | dict(count=14, label="2 semaine", step="day", stepmode="backward"), 435 | dict(count=1, label="1 mois", step="month", stepmode="backward"), 436 | dict(label="toute la période", step="all") 437 | ])), 438 | tickformatstops = [ 439 | dict(dtickrange=[None, 86400000], value="%e %b"), 440 | dict(dtickrange=[86400000, 604800000], value="sem. %W"), 441 | dict(dtickrange=[604800000, None], value="%b %Y"), 442 | ] 443 | ) 444 | 445 | fig.update_yaxes( 446 | title='', 447 | tickfont=dict(size=13, family="Lato"), 448 | type='category', 449 | categoryorder='category ascending', 450 | showline=True, 451 | linewidth=2, 452 | linecolor='SlateGrey', 453 | ticks="outside", 454 | tickcolor='SlateGrey', 455 | ticklen=4, 456 | tickwidth=2, 457 | fixedrange=True 458 | ) 459 | 460 | fig.update_layout( 461 | title={'text': "Avancement du stage de Louis Héraut encadré par Louis Gostiaux
Séries temporelles de température dans l'océan profond: ré-analyse des données haute résolution de thermistors NIOZ-HST sur la
période 2006-2016 visant à l'étude des statistiques d'ordre élevé dans les écoulements géophysiques avec rotation et stratification", 462 | 'font':dict(size=18), 463 | 'y':0.96, 464 | 'x':0.085}, 465 | barmode='overlay', 466 | margin=dict(l=80, r=10, t=140, b=60), 467 | plot_bgcolor='white', 468 | height=1100, 469 | width=1300) 470 | 471 | # plotting 472 | fig.write_html("example_pygantt.html") 473 | if not os.path.exists("figures"): 474 | os.mkdir("figures") 475 | fig.write_image("figures/example_pygantt_1.png", scale=2) 476 | fig.show() -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------