-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.html
526 lines (525 loc) · 17.8 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>README</title>
<style>
html {
line-height: 1.5;
font-family: Georgia, serif;
font-size: 20px;
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 1em;
}
h1 {
font-size: 1.8em;
}
}
@media print {
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
font-size: 85%;
margin: 0;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">README</h1>
<p class="date">January, 2023</p>
</header>
<style type="text/css" media="screen">
#suggestions {
margin-top: 35px;
color: #ccc;
}
#suggestions a {
color: #666666;
font-weight: 200;
font-size: 14px;
margin: 0 10px;
}
h1, h2, h3, h4, h5, h6 {
font-family: Verdana, "DejaVu Sans", "Bitstream Vera Sans", Geneva, sans-serif;
font-weight: bold;
}
body, exercice {
font-family: Verdana, "DejaVu Sans", "Bitstream Vera Sans", Geneva, sans-serif;
font-weight: 200;
}
h1 {
border: 0 solid #333;
padding: 30px ;
color: white;
background: #b11d01;
text-align: center;
}
h2 {
border: 3px solid #333;
padding: 18px ;
color: #b11d01;
background: #ffffff;
text-align: center;
}
h3 {
border: 0 solid #333;
padding: 12px ;
color: #000000;
background: #c1c1c1;
text-align: left;
}
h4 {
border: 0 solid #333;
padding: 2px ;
color: #000000;
background: #d9fffc;
text-align: left;
}
h5 {
border: 1px solid #333;
padding: 2px ;
color: #000000;
background: #ffffff;
text-align: left;
}
.rq {
background-color: #fcf2f2;
border-color: #dFb5b4;
border-left: 5px solid #dfb5b4;
padding: 0.5em;
font-weight: 200;
}
.intro {
background-color: #f1f1f1;
border-color: #969696;
border-left: 5px solid #969696;
padding: 0.5em;
font-weight: 200;
}
.exold {
background-color: #b2dbea80;
border-color: #0055ff;
border-left: 10px solid #0055ff;
padding: 0.5em;
font-weight: 200;
}
.ex {
background-color: #b2dbea80;
padding: 0.5em;
padding-top: 0em;
font-weight: 200;
position:relative;
}
.ex::before {
background-color: #b2dbea;
content:"Exercice";
margin-left:-0.5em;
margin-right:-0.5em;
padding-left:0.5em;
padding-right:0.5em;
font-weight: 600;
display: block;
}
.app {
background-color: #b2dbea80;
padding: 0.5em;
padding-top: 0em;
font-weight: 200;
position:relative;
}
.app::before {
background-color: #b2dbea;
content:"Application";
margin-left:-0.5em;
margin-right:-0.5em;
padding-left:0.5em;
padding-right:0.5em;
font-weight: 600;
display: block;
}
</style>
<p><a name="top"></p>
<p></a><img width="700px" src="./config/svg/logo_pyPhysChem.svg"/></p>
<p>Des exemples commentés et généralement illustrés sont disponibles
sous forme de Jupyter Notebooks</p>
<p><em>Commented and generally illustrated examples are available in the
form of Jupyter Notebooks</em></p>
<ul>
<li><a href="#main">Document principal et pré-requis / <em>Main document
and prerequisites</em></a></li>
<li><a href="#howto">Comment lire et utiliser ces notebooks ? / <em>How
to read and use these notebooks?</em></a>
<ul>
<li><a href="#howto1"><strong>1.</strong> Installer Jupyter ainsi qu’une
distribution Python / <em>Install Jupyter as well as a Python
distribution</em></a></li>
<li><a href="#howto2"><strong>2.</strong> Cloner ou Télécharger le dépôt
(repository) pyPhysChem / <em>Clone or Download the pyPhysChem
repository</em></a>
<ul>
<li><a href="#cloneL">Linux</a></li>
<li><a href="#cloneW">Windows</a></li>
</ul></li>
<li><a href="#howto3"><strong>3.</strong> Exécuter ces notebooks à
l’aide de JupyterLab / Run these notebooks with JupyterLab</a>
<ul>
<li><a href="#jupL">Linux</a></li>
<li><a href="#jupW">Windows</a></li>
</ul></li>
</ul></li>
<li><a href="#lib">Bibliothèques nécessaires / <em>Required
libraries</em></a></li>
<li><a href="#changes">Liste des changements / <em>List of
changes</em></a></li>
</ul>
<h2
id="document-principal-et-pré-requis-main-document-and-prerequisites"><a name="main"></a>
Document principal et pré-requis / <em>Main document and
prerequisites</em></h2>
<p>Il faut lire le fichier <a href="./TOC.ipynb">TOC.ipynb</a>, qui
renvoie vers des sous-thèmes. Chaque sous-thème est introduit par les
objectifs de ces TP, ainsi qu’une table des matières qui permet
d’accéder aux cours/TP et aux exercices.</p>
<p><strong>Pré-requis</strong> : des notions très élémentaires
d’algorithmique (variables, tests conditionnels, boucles). <span
style="color:red">🤔 Vous voulez rafraîchir vos connaissances et
renforcer vos acquis ?</span> <strong>Le notebook <a
href="./PPCL.ipynb">PPCL.ipynb</a> est fait pour ça. Il est un peu long,
mais il en vaut la peine</strong> 😊. Vous pouvez peut-être même vous
lancer sans aucune connaissance algorithmique de base. C’est à vous de
voir si cela vous suffit.💪💪🏼💪🏿</p>
<p><em>Read the <a href="./TOC.ipynb">TOC.ipynb</a> file, which points
to subtopics. Each subtopic is introduced by the goals of the course, as
well as a table of contents that allows access to the courses/tutorials
and exercises.</em></p>
<p><em><strong>Prerequisite</strong> : very basic notions of algorithmic
(variables, conditional tests, loops).</em> <span style="color:red">🤔
<em>Do you want to refresh your knowledge and reinforce your
skills?</em></span> <strong><em>This is what the <a
href="./PPCL.ipynb">PPCL.ipynb</a> notebook is for. It’s a bit long, but
it’s worth the effort</em></strong> 😊. <em>You may even be able to get
started without any basic algorithmic knowledge. It’s up to you to see
if that’s enough for you.</em>💪💪🏼💪🏿</p>
<h2
id="comment-lire-et-utiliser-ces-notebooks-how-to-read-and-use-these-notebooks"><a name="howto"></a>Comment
lire et utiliser ces notebooks ? / <em>How to read and use these
notebooks?</em></h2>
<h3
id="installer-jupyter-ainsi-quune-distribution-python-install-jupyter-as-well-as-a-python-distribution"><a name="howto1"></a><strong>1.</strong>
Installer Jupyter ainsi qu’une distribution Python / <em>Install Jupyter
as well as a Python distribution</em></h3>
<p>Il faut d’abord avoir installé <a
href="https://jupyter.org/">Jupyter</a> ainsi qu’une distribution python
sur son PC.</p>
<p>La solution la plus simple est d’installer et utiliser <a
href="https://www.anaconda.com/">Anaconda</a>, qui est une distribution
libre et open source du langage de programmation Python :</p>
<ul>
<li>Les versions de paquetages sont gérées par le système de gestion de
paquets conda</li>
<li>Elle comprend également Anaconda Navigator, qui est une interface
graphique “user-friendly”</li>
<li>Les applications suivantes sont disponibles par défaut dans le
navigateur :
<ul>
<li>JupyterLab & Jupyter Notebook</li>
<li>Spyder</li>
<li>RStudio</li>
<li>…</li>
</ul></li>
<li>Anaconda est disponible pour MacOS, Windows, Linux.</li>
</ul>
<p><em>First install <a href="https://jupyter.org/">Jupyter</a> as well
as a Python distribution on your PC.</em></p>
<p><em>A simple and easy possibility is to install <a
href="https://www.anaconda.com/">Anaconda</a>, a free and opensource
distribution of the Python programming language:</em></p>
<ul>
<li><em>Package versions are managed by the package management system
conda</em></li>
<li><em>It also includes a user friendly GUI, Anaconda
Navigator</em></li>
<li><em>The following applications are available by default in
Navigator:</em>
<ul>
<li><em>JupyterLab & Jupyter Notebook</em></li>
<li><em>Spyder</em></li>
<li><em>RStudio</em></li>
<li>…</li>
</ul></li>
<li><em>Anaconda runs under MacOS, Windows, Linux.</em></li>
</ul>
<p><a href="#top">🔝 top 🔝</a></p>
<h3
id="cloner-ou-télécharger-le-dépôt-repository-pytchem-clone-or-download-the-pytchem-repository"><a name="howto2"></a><strong>2.</strong>
Cloner ou Télécharger le dépôt (repository) pyPhysChem / <em>Clone or
Download the pyPhysChem repository</em></h3>
<h4 id="télécharger-download">Télécharger / <em>Download</em></h4>
<p><strong>Ce n’est pas la façon de faire qui est recommandée</strong>,
bien que ce soit la plus simple. Essayez plutôt le clonage (voir
paragraphe “cloner le dépôt” ci-dessous 👇) / <em><strong>It is not the
recommended way</strong>, although it is the simplest. Try clone the
repository instead (see the “clone repository” subsection below</em>
👇)</p>
<p>Téléchargez l’archive zip / Download the zip archive</p>
<p><img width="650px" src="./MiscImages/DownloadZip.png"/></p>
<h4 id="cloner-le-dépôt-clone-the-repository">Cloner le dépôt /
<em>Clone the repository</em></h4>
<p><strong>C’est la méthode recommandée</strong>, car elle facilite la
mise à jour des notebooks / <em><strong>This is the recommended
way</strong>, given the ease of updating notebooks</em></p>
<h5 id="sous-linux-under-linux"><a name="cloneL">Sous Linux / <em>Under
Linux</em></h5>
<p>Ouvrez un terminal. Depuis le répertoire où vous voulez installer les
notebooks, tapez la commande : / <em>Open a terminal. Go into the folder
in which the notebooks will be installed, and type:</em></p>
<pre><code>git clone https://github.com/rpoteau/pyPhysChem.git</code></pre>
<p>Vous avez maintenant un répertoire <code>pyPhysChem</code> dans le
répertoire depuis lequel vous avez lancé la commande <code>git</code> /
<em>You now have a <code>pyPhysChem</code> folder installed in the folder
from which the <code>git</code> command was ran</em></p>
<p>pyPhysChem étant un projet en évolution, il faut régulièrement vérifier
qu’il n’y a pas de mise à jour. La commande suivante met si nécessaire à
jour le contenu du répertoire <code>Pytchem</code> / <em>Pytchem being a
work-in-progress project, it is necessary to regularly check for a
possible update. The content of the <code>pyPhysChem</code> folder is
updated by using the following command</em>:</p>
<p>allez d’abord dans le répertoire pyPhysChem / <em>first go into the
<code>pyPhysChem</code> folder</em></p>
<p>puis tapez / <em>and then enter</em></p>
<pre><code>git pull origin main</code></pre>
<h5 id="sous-windows-under-windows"><a name="cloneW">Sous Windows /
Under Windows</h5>
<p>Vous devez télécharger et installer <a
href="https://gitforwindows.org/">l’application git</a>. Ne changez
aucune option par défaut, à l’exception de l’éditeur Nano au lieu de vi
/ <em>You must download and install <a
href="https://gitforwindows.org/">the git application</a>. Do not change
any default options, except for the Nano editor instead of vi</em></p>
<p>Exécutez ensuite l’application Git GUI. Ça devrait ressembler à ça :
/ <em>Then run the Git GUI application. It should look like:</em></p>
<p><img width="400px" src="./MiscImages/GitGUI-Windows-0.png"/></p>
<p>Cliquez sur “Clone existing repository”. Collez l’adresse
https://github.com/rpoteau/pyPhysChem.git dans le champ “Source location”.
Choisissez un emplacement où cloner pyPhysChem dans “Target Directory”,
ajoutez pyPhysChem au chemin. Ce répertoire va être créé par Git GUI /
<em>Click on “Clone existing repository”. Paste the
https://github.com/rpoteau/pyPhysChem.git in the “Source location” field.
Choose the local target folder. Add pyPhysChem to the pathway. This folder
will be created by Git GUI</em></p>
<p><img width="550px" src="./MiscImages/GitGUI-Windows-1.png"/></p>
<p>Cliquez sur “Clone”. Patientez. À la fin de l’installation, vous
allez voir cette fenêtre : / <em>Click on “Clone”. Wait. This window
will appear after the installation is completed:</em></p>
<p><img width="650px" src="./MiscImages/GitGUI-Windows-2.png"/></p>
<p>Vous pouvez fermer cette application / <em>You can close this
application</em></p>
<p><a href="#top">🔝 top 🔝</a></p>
<h3
id="exécuter-ces-notebooks-à-laide-de-jupyterlab-run-these-notebooks-with-jupyterlab"><a name="howto3"></a><strong>3.</strong>
Exécuter ces notebooks à l’aide de JupyterLab / Run these notebooks with
JupyterLab</h3>
<h4 id="sous-linux-under-linux-1"><a name="jupL">Sous Linux / <em>Under
Linux</em></h4>
<ul>
<li>Ouvrez un terminal / <em>Open a terminal</em></li>
<li>Allez (commande <code>cd chemin d'accès</code>) dans le répertoire
qui contient pyPhysChem / <em>Navigate to the folder that contains pyPhysChem
(<code>cd pathway</code>)</em></li>
<li>tapez la commande / <em>enter the command</em></li>
</ul>
<pre><code>jupyter-lab TOC.ipynb</code></pre>
<h4 id="sous-windows-under-windows-1"><a name="jupW">Sous Windows /
<em>Under Windows</em></h4>
<p>Le plus simple est de passer par Anaconda Navigator, puis de
sélectionner JupyterLab / <em>The easiest way is to select JupyterLab
from Anaconda Navigator</em></p>
<p><img width="700px" src="./MiscImages/Anaconda.png"/></p>
<p>Il ne reste plus qu’à naviguer jusqu’au répertoire qui contient
pyPhysChem, et à charger la table des matières intitulée
<code>TOC.ipynb</code> / <em>All that remains is to navigate to the
directory that contains pyPhysChem, and load the table of contents entitled
<code>TOC.ipynb</code>.</em></p>
<p><img width="650px" src="./MiscImages/JupyterLab.png"/></p>
<p><a href="#top">🔝 top 🔝</a></p>
<h2
id="bibliothèques-nécessaires-required-libraries"><a name="lib"></a>Bibliothèques
nécessaires / <em>Required libraries</em></h2>
<p>Vous devez installer les bibliothèques suivantes dans votre
environnement Python / <em>You must install the following libraries in
your Python environment</em>:</p>
<ul>
<li>matplotlib ✅</li>
<li>numpy ✅</li>
<li>scipy ✅</li>
<li>sympy ✅</li>
<li>pandas ✅</li>
<li>seaborn ✅</li>
<li>scikit learn ✅</li>
<li>tensorflow ❌</li>
<li>keras ❌</li>
<li>plotly ✅ <br><br></li>
<li>✅ = bibliothèque installée par défaut avec Anaconda / <em>library
installed by default in Anaconda</em></li>
<li>❌ = bibliothèque à installer dans l’environnement de base de
Anaconda / <em>library to be installed in the base environment of
Anaconda</em>:
<ul>
<li>dans Anaconda navigator, cliquez sur “Environments”, puis sur “Base”
/ <em>select “Environments” and “Base” in Anaconda Navigator</em></li>
<li>puis sélectionnez “not installed”, et enfin entrez dans le champ
“search package” le nom de la bibliothèque que vous voulez installer
(exemple keras) / <em>then select “not installed”, and finally enter in
the “search package” field the name of the library you want to install
(e.g. keras)</em></li>
</ul></li>
</ul>
<p><img width="800px" src="./MiscImages/AnacondaAddLib.png"/></p>
<h2
id="liste-des-changements-list-of-changes"><a name="changes"></a>Liste
des changements / <em>List of changes</em></h2>
<p><a href="./CHANGE.md">🔄 Liste des changements / <em>List of
changes</em> 🔄</a></p>
<p><a href="#top">🔝 top 🔝</a></p>
</body>
</html>