Skip to content

Commit 77189cd

Browse files
committed
added pycharm installation instructions for windows
1 parent d893df3 commit 77189cd

27 files changed

+211
-11
lines changed

notation/acronyms.sty

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
\RequirePackage{hyperref}%%%
2+
%%% The acronyms.
3+
%%%
4+
%
5+
\newacronym{IDE}{IDE}{Integrated Development Environment, see also \gls{ide}}%
6+
%

notation/notation.sty

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
\RequirePackage{notation/software}%
33
\RequirePackage{notation/sources}%
44
\RequirePackage{notation/terms}%
5+
\RequirePackage{notation/acronyms}%
56
%

notation/software.sty

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ description={The \href{https://python.org/}{\softwareStyle{Python}} programming
1414
\xdef\pythonVersion{3.10}%
1515
\protected\gdef\pythonWithVersion{\softwareStyle{\python~\pythonVersion}}%
1616
%
17+
%
18+
\newglossaryentry{linux}{%
19+
name={\softwareStyle{Linux}},
20+
sort={Linux},
21+
description={%
22+
\href{https://www.linux.org/}{\softwareStyle{Linux}} is an open source operating system, i.e., a free alternative for \windows. %
23+
Its variant \ubuntu\ is particularly easy to use and install. %
24+
We recommend using it for this course, for software development, and for research.%
25+
}%
26+
}%
27+
\protected\gdef\linux{\gls{linux}}%
28+
%
29+
%
30+
\newglossaryentry{pycharm}{%
31+
name={\softwareStyle{PyCharm}},
32+
sort={PyCharm},
33+
description={%
34+
\href{https://www.jetbrains.com/pycharm/}{\softwareStyle{PyCharm}} is the convenient \python\ \gls{ide} that we recommend for this course.%
35+
}%
36+
}%
37+
\protected\gdef\pycharm{\gls{pycharm}}%
38+
%
39+
%
1740
\newglossaryentry{ubuntu}{%
1841
name={\softwareStyle{Ubuntu}},
1942
sort={Ubuntu},
@@ -26,16 +49,6 @@ If you are in China, you can download it from \expandafter{\ubuntuDownloadUrl}.%
2649
\protected\gdef\ubuntu{\gls{ubuntu}}%
2750
\xdef\ubuntuDownloadUrl{https://mirrors.ustc.edu.cn/ubuntu-releases/}%
2851
%
29-
\newglossaryentry{linux}{%
30-
name={\softwareStyle{Linux}},
31-
sort={Linux},
32-
description={%
33-
\href{https://www.linux.org/}{\softwareStyle{Linux}} is an open source operating system, i.e., a free alternative for \windows. %
34-
Its variant \ubuntu\ is particularly easy to use and install. %
35-
We recommend using it for this course, for software development, and for research.%
36-
}%
37-
}%
38-
\protected\gdef\linux{\gls{linux}}%
3952
%
4053
\newglossaryentry{windows}{%
4154
name={\softwareStyle{Windows}},

notation/terms.sty

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@
33
%%
44
%
55
%
6+
\newglossaryentry{ide}{%
7+
name={Integrated Development Environment},
8+
sort={Integrated Development Environment},
9+
description={%
10+
A \gls{IDE} is a program that allows the user do multiple different activities required for software development in one single system. %
11+
It often offers functionality such as editing source code, debugging, testing, or interaction with a distributed version control system. %
12+
For this course, we recommend using \pycharm.%
13+
}%
14+
}%
15+
%
16+
%
617
\newglossaryentry{terminal}{%
718
name={terminal},
819
plural={terminals},

text/back/backmatter.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
%
1111
%\printRulesOfThumb%
1212
%\printsymbols%
13-
%\printacronyms%
13+
\printacronyms%
1414
\printglossaries%
1515
\printbibliography%
1616
%

text/main/basics/gettingStarted/gettingStarted.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This course should be a practical course, so we should get started with practical things right away.
44
%
55
\hinput{installingPython}{installingPython}%
6+
\hinput{installingPyCharm}{installingPyCharm}%
67
%
78
\endhsection%
89
%
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
\hsection{Installing PyCharm}%
2+
%
3+
Just having a programming language and the corresponding interpreter on your system is not enough.
4+
Are you going to write programs in a simple text editor like a caveperson?
5+
No, of course not, you need an \gls{IDE}, a program which allows you to do multiple of the necessary tasks involved in the software development process under one convenient user interface.
6+
For this course, we recommend using \pycharm, whose community edition is freely available.
7+
The installation guide for \pycharm\ can be found at \url{https://www.jetbrains.com/help/pycharm/installation-guide.html}.%
8+
%
9+
\hinput{installingPyCharmWindows}{installingPyCharmWindows}%
10+
\afterpage{\clearpage}%
11+
\endhsection%
12+
%
Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
\hsection{Installing PyCharm under Microsoft Windows}%
2+
%
3+
\begin{figure}%
4+
\centering%
5+
%
6+
\subfloat[][%
7+
The download website \url{https://www.jetbrains.com/pycharm/download} for \pycharm.%
8+
\label{fig:installingPyCharmWindows01download}%
9+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows01download}}}%
10+
%
11+
\hfill%
12+
%
13+
\subfloat[][%
14+
Downloading the \pycharm\ Community Edition.%
15+
\label{fig:installingPyCharmWindows02download}%
16+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows02download}}}%
17+
%
18+
\\[10pt]%
19+
%
20+
\subfloat[][%
21+
Selecting the normal \windows\ installer for the \pycharm\ Community Edition.%
22+
\label{fig:installingPyCharmWindows03download}%
23+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows03download}}}%
24+
%
25+
\hfill%
26+
%
27+
\subfloat[][%
28+
The download is starting.%
29+
\label{fig:installingPyCharmWindows04download}%
30+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows04download}}}%
31+
%
32+
\\[10pt]%
33+
%
34+
\subfloat[][%
35+
The download is completed. We click \keys{Open file}.%
36+
\label{fig:installingPyCharmWindows05runInstaller}%
37+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows05runInstaller}}}%
38+
%
39+
\hfill%
40+
%
41+
\subfloat[][%
42+
The installer is starting.%
43+
\label{fig:installingPyCharmWindows06runInstaller}%
44+
]{\tightbox{\includegraphics[width=0.47\linewidth]{\currentDir/installingPyCharmWindows06runInstaller}}}%
45+
%
46+
\\[10pt]%
47+
%
48+
\subfloat[][%
49+
The installer is starting.%
50+
\label{fig:installingPyCharmWindows07runInstaller}%
51+
]{\tightbox{\includegraphics[height=3.75cm]{\currentDir/installingPyCharmWindows07runInstaller}}}%
52+
%
53+
\hfill\hfill%%
54+
%
55+
\subfloat[][%
56+
We do want to install, so click \keys{Yes}.%
57+
\label{fig:installingPyCharmWindows08runInstaller}%
58+
]{\tightbox{\includegraphics[height=3.75cm]{\currentDir/installingPyCharmWindows08runInstaller}}}%
59+
\hfill\strut%
60+
%
61+
\caption{The installation steps of \pycharm\ under \windows.}%
62+
\label{installingPyCharmWindowsA}%
63+
%
64+
\end{figure}%
65+
%
66+
\begin{figure}%
67+
\ContinuedFloat%
68+
\centering%
69+
%
70+
\subfloat[][%
71+
The welcome screen of the installer. We click \keys{Next}.%
72+
\label{fig:installingPyCharmWindows09installation}%
73+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows09installation}}}%
74+
%
75+
\hfill%
76+
%
77+
\subfloat[][%
78+
The installation folder selection. We click \keys{Next}.%
79+
\label{fig:installingPyCharmWindows10installation}%
80+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows10installation}}}%
81+
%
82+
\hfill%
83+
%
84+
\subfloat[][%
85+
The installation options. We can click \keys{Next}.%
86+
\label{fig:installingPyCharmWindows11installation}%
87+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows11installation}}}%
88+
%
89+
\\[10pt]%
90+
%
91+
\subfloat[][%
92+
The start menu folder choose dialog. We click \keys{Install}.%
93+
\label{fig:installingPyCharmWindows12installation}%
94+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows12installation}}}%
95+
%
96+
\hfill%
97+
%
98+
\subfloat[][%
99+
The install process starts.%
100+
\label{fig:installingPyCharmWindows13installation}%
101+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows13installation}}}%
102+
%
103+
\hfill%
104+
%
105+
\subfloat[][%
106+
The installation is finished. Select ``Run PyCharm Community Edition'' and click \keys{Finish}.%
107+
\label{fig:installingPyCharmWindows14installation}%
108+
]{\tightbox{\includegraphics[height=4cm]{\currentDir/installingPyCharmWindows14installation}}}%
109+
%
110+
\\[10pt]%
111+
%
112+
\strut\hfill\strut%
113+
\subfloat[][%
114+
The welcome screen of \pycharm.%
115+
\label{fig:installingPyCharmWindows15running}%
116+
]{\tightbox{\includegraphics[width=0.4\linewidth]{\currentDir/installingPyCharmWindows15running}}}%
117+
%
118+
\strut\hfill\strut\strut\hfill\strut%%
119+
%
120+
\subfloat[][%
121+
We read the user agreement, confirm that we read it, and click \keys{Continue}.%
122+
\label{fig:installingPyCharmWindows16running}%
123+
]{\tightbox{\includegraphics[width=0.4\linewidth]{\currentDir/installingPyCharmWindows16running}}}%
124+
\strut\hfill\strut%
125+
%
126+
\\[10pt]%
127+
%
128+
\strut\hfill\strut%
129+
\subfloat[][%
130+
We do not want to send any data and click \keys{Don't Send}.%
131+
\label{fig:installingPyCharmWindows17running}%
132+
]{\tightbox{\includegraphics[width=0.4\linewidth]{\currentDir/installingPyCharmWindows17running}}}%
133+
%
134+
\strut\hfill\strut\strut\hfill\strut%%
135+
%
136+
\subfloat[][%
137+
Finally, \pycharm\ is ready to use.%
138+
\label{fig:installingPyCharmWindows18running}%
139+
]{\tightbox{\includegraphics[width=0.4\linewidth]{\currentDir/installingPyCharmWindows18running}}}%
140+
\strut\hfill\strut%
141+
%
142+
\caption[]{The installation steps of \pycharm\ under \windows.}%
143+
\label{installingPyCharmWindowsB}%
144+
\end{figure}%
145+
%
146+
Under \windows, you first need to download the \pycharm\ Community Edition installation executable from \url{https://www.jetbrains.com/pycharm/download}.
147+
Make sure to download the Community Edition and nothing else, as shown in \cref{fig:installingPyCharmWindows01download,fig:installingPyCharmWindows02download,fig:installingPyCharmWindows03download}.
148+
Once the installer is downloaded, you start it and confirm that you wish to install \pycharm, as illustrated in \cref{fig:installingPyCharmWindows05runInstaller,fig:installingPyCharmWindows06runInstaller,fig:installingPyCharmWindows07runInstaller,fig:installingPyCharmWindows08runInstaller}.
149+
As \cref{fig:installingPyCharmWindows09installation,fig:installingPyCharmWindows10installation,fig:installingPyCharmWindows11installation} show, the installation setup process is more or less automated, we just need to click \keys{Next} here and there and finally click \keys{Install}~(\cref{fig:installingPyCharmWindows12installation}).
150+
After the installation completes, we run \pycharm\ for the first time.
151+
Now we need to agree to the user agreement~(\cref{fig:installingPyCharmWindows16running}) and should probably choose that we do not with to send any information about our \pycharm\ usage out~(\cref{fig:installingPyCharmWindows17running}).
152+
Finally, as sketched in \cref{fig:installingPyCharmWindows18running}, we have a running and ready \pycharm\ \gls{IDE}.%
153+
%
154+
\endhsection%
155+
%

text/main/basics/gettingStarted/installingPython/installingPython.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
%
1414
\hinput{installingPythonWindows}{installingPythonWindows}%
1515
\hinput{pythonUnderUbuntu}{pythonUnderUbuntu}%
16+
\afterpage{\clearpage}%
1617
%
1718
\endhsection%
1819
%

0 commit comments

Comments
 (0)