Skip to content

Commit 9fbcbe8

Browse files
committed
added pycharm installation instructions for ubuntu
1 parent 77189cd commit 9fbcbe8

17 files changed

+109
-13
lines changed

notation/software.sty

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ description={The \href{https://python.org/}{\softwareStyle{Python}} programming
1919
name={\softwareStyle{Linux}},
2020
sort={Linux},
2121
description={%
22-
\href{https://www.linux.org/}{\softwareStyle{Linux}} is an open source operating system, i.e., a free alternative for \windows. %
22+
is an open source operating system, i.e., a free alternative for \windows. %
2323
Its variant \ubuntu\ is particularly easy to use and install. %
2424
We recommend using it for this course, for software development, and for research.%
2525
}%
@@ -31,7 +31,7 @@ We recommend using it for this course, for software development, and for researc
3131
name={\softwareStyle{PyCharm}},
3232
sort={PyCharm},
3333
description={%
34-
\href{https://www.jetbrains.com/pycharm/}{\softwareStyle{PyCharm}} is the convenient \python\ \gls{ide} that we recommend for this course.%
34+
is the convenient \python\ \gls{ide} that we recommend for this course.%
3535
}%
3636
}%
3737
\protected\gdef\pycharm{\gls{pycharm}}%
@@ -41,9 +41,9 @@ description={%
4141
name={\softwareStyle{Ubuntu}},
4242
sort={Ubuntu},
4343
description={%
44-
\href{https://ubuntu.com/}{\softwareStyle{Ubuntu}} is a variant of the open source operating system \linux. %
44+
is a variant of the open source operating system \linux. %
4545
We recommend that you use this operating system to follow this class, for software development, and for research. %
46-
If you are in China, you can download it from \expandafter{\ubuntuDownloadUrl}.%
46+
If you are in China, you can download it from \expandafter\url{\ubuntuDownloadUrl}.%
4747
}%
4848
}%
4949
\protected\gdef\ubuntu{\gls{ubuntu}}%

notation/terms.sty

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,25 @@ For this course, we recommend using \pycharm.%
1414
}%
1515
%
1616
%
17+
\newglossaryentry{sudo}{%
18+
name={\texttt{sudo}},
19+
sort={sudo},
20+
description={%
21+
In order to perform administrative tasks such as installing new software under \linux, root (or ``super'') user privileges as needed. %
22+
A normal user can execute a program in the \gls{terminal} as super user by pre-pending \bashil{sudo}, often referred to as ``super user do.'' %
23+
This requires the root password.%
24+
}%
25+
}%
26+
%
27+
%
1728
\newglossaryentry{terminal}{%
1829
name={terminal},
1930
plural={terminals},
2031
description={%
2132
A terminal is a text-based window where you can enter commands and execute them by pressing \keys{\return}. %
2233
Knowing what a terminal is and how to use it is very essential in any programming- or system administration-related task. %
23-
If you want to open a terminal under \windows, you can press \keys{\OSwin + R}, type in \bashil{cmd}, and hit \keys{\return}, as shown, e.g., in \cpageref{fig:installingPythonWindows01openTerminal}. %
24-
Under \ubuntu\ \linux, \keys{\ctrl+\Alt+T} opens a terminal.%
25-
}
34+
If you want to open a terminal under \windows, you can \windowsTerminal, as shown, e.g., in \cpageref{fig:installingPythonWindows01openTerminal}. %
35+
Under \ubuntu\ \linux, \ubuntuTerminal\ opens a terminal.%
36+
}%
2637
}%
2738
%

styles/keys.sty

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@
1111
\tw@make@key@box{OS@win}{\faWindows}%
1212
\tw@make@key@macro*{\OS}%
1313
%
14+
\protected\gdef\ubuntuTerminal{\keys{\ctrl+\Alt+T}}%
15+
\protected\gdef\windowsTerminal{press \keys{\OSwin + R}, type in \bashil{cmd}, and hit \keys{\return}}%

text/main/basics/gettingStarted/installingPyCharm/installingPyCharm.tex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
The installation guide for \pycharm\ can be found at \url{https://www.jetbrains.com/help/pycharm/installation-guide.html}.%
88
%
99
\hinput{installingPyCharmWindows}{installingPyCharmWindows}%
10+
\hinput{installingPyCharmUbuntu}{installingPyCharmUbuntu}%
1011
\afterpage{\clearpage}%
1112
\endhsection%
1213
%
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
\hsection{Installing PyCharm under Ubuntu Linux}%
2+
%
3+
\begin{figure}%
4+
\centering%
5+
%
6+
\subfloat[][%
7+
Installing \pycharm\ using the snap install command in a \gls{terminal} opened with \ubuntuTerminal.%
8+
\label{fig:installingPyCharmUbuntu01snapInstall}%
9+
]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu01snapInstall}}%
10+
%
11+
\\[10pt]
12+
%
13+
\subfloat[][%
14+
This command requires the super user password.%
15+
\label{fig:installingPyCharmUbuntu02sudo}%
16+
]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu02sudo}}%
17+
%
18+
\\[10pt]%
19+
%
20+
\subfloat[][%
21+
The installation begins.%
22+
\label{fig:installingPyCharmUbuntu03snapInstall}%
23+
]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu03snapInstall}}%
24+
%
25+
\\[10pt]%
26+
%
27+
\subfloat[][%
28+
The software package is downloaded.%
29+
\label{fig:installingPyCharmUbuntu04snapInstall}%
30+
]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu04snapInstall}}%
31+
%
32+
\\[10pt]%
33+
%
34+
\subfloat[][%
35+
The package is installed.%
36+
\label{fig:installingPyCharmUbuntu05snapInstallFinished}%
37+
]{\includegraphics[width=0.7\linewidth]{\currentDir/installingPyCharmUbuntu05snapInstallFinished}}%
38+
%
39+
\\[10pt]%
40+
%
41+
\subfloat[][%
42+
Open the launcher by pressing \OSwin\ and type in \bashil{pycharm} to find the \pycharm\ executable, then double-click it.%
43+
\label{fig:installingPyCharmUbuntu06launcher}%
44+
]{\tightbox{\includegraphics[height=3.1cm]{\currentDir/installingPyCharmUbuntu06launcher}}}%
45+
%
46+
\hfill%
47+
%
48+
\subfloat[][%
49+
The \pycharm\ welcome screen appears.%
50+
\label{fig:installingPyCharmUbuntu07welcome}%
51+
]{\tightbox{\includegraphics[height=3.1cm]{\currentDir/installingPyCharmUbuntu07welcome}}}%
52+
%
53+
\hfill%%
54+
%
55+
\subfloat[][%
56+
\pycharm\ has been started.%
57+
\label{fig:installingPyCharmUbuntu08pycharm}%
58+
]{\tightbox{\includegraphics[height=3.1cm]{\currentDir/installingPyCharmUbuntu08pycharm}}}%
59+
%
60+
\caption{The installation steps of \pycharm\ under \ubuntu\ linux.}%
61+
\label{fig:installingPyCharmUbuntu}%
62+
\end{figure}%
63+
%
64+
Installing \pycharm\ under \ubuntu\ \linux\ is very easy, as illustrated in \cref{fig:installingPyCharmUbuntu}.
65+
First, you open a \gls{terminal} by pressing \ubuntuTerminal.
66+
Then, enter the command \bashil{sudo snap install pycharm-community --classic} and hit return~(\cref{fig:installingPyCharmUbuntu01snapInstall}).
67+
This installs the \pycharm\ software package and the necessary super user privileges are obtained via the pre-pended \gls{sudo}, which will ask us to enter the root password, as sketched in \cref{fig:installingPyCharmUbuntu02sudo}.
68+
Then, the installation process basically runs automatically.
69+
Once it has completed (see \cref{fig:installingPyCharmUbuntu05snapInstallFinished}), you can press the \keys{\OSwin} key and type \bashil{pycharm} in the launcher window to find \pycharm~(\cref{fig:installingPyCharmUbuntu06launcher}).
70+
A double-click will open \pycharm.
71+
72+
In the installation instructions for \windows, now a user agreement~(\cref{fig:installingPyCharmWindows16running}) and data upload statement~(\cref{fig:installingPyCharmWindows17running}) need to be performed.
73+
Since I already had \pycharm\ installed previously and probably already agreed/disagreed to them, respectively, these windows did not open in my current installation and I could not take screenshots of them.
74+
If they open, then you can probably treat them exactly as suggested in the \windows\ installation instructions \cref{sec:installingPyCharmWindows}.
75+
Either way, we finally get \pycharm\ up and running and can begin our coding~(\cref{fig:installingPyCharmUbuntu08pycharm}).
76+
%
77+
\endhsection%
78+
%

0 commit comments

Comments
 (0)