pytutorial/workflow/python_pure/README.md
David Rotermund 698a438aca
Update README.md
Signed-off-by: David Rotermund <davrot@uni-bremen.de>
2024-08-15 20:00:02 +02:00

259 lines
9.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Python installation (Windows / Linux)
{:.no_toc}
<nav markdown="1" class="toc-class">
* TOC
{:toc}
</nav>
## Goal
Install your very own Python and keep everything under control.
Questions to [David Rotermund](mailto:davrot@uni-bremen.de)
We need to download a suitable Python version from [https://www.python.org](https://www.python.org). In the case we want to use PyTorch [check here](https://pytorch.org/get-started/locally/#windows-python) or TensorFlow [check here](https://www.tensorflow.org/install/pip#software_requirements) we need to check if the Python version is okay.
## Windows
I downloaded this file:
[https://www.python.org/ftp/python/3.11.7/python-3.11.9-amd64.exe](https://www.python.org/ftp/python/3.11.7/python-3.11.9-amd64.exe)
![figure 1](Image1.png)
Select "Add python.exe to Path" and then press "Install Now".
We need to update pip first:
```shell
python.exe -m pip install --upgrade pip
```
### ffmpeg
You might need to create mp4 files. E.g. for saving matplotlib animations
Thus you need ffmpeg binaries. You find them here:
[https://www.gyan.dev/ffmpeg/builds/](https://www.gyan.dev/ffmpeg/builds/)
I went for
[https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-6.0-full_build.7z](https://www.gyan.dev/ffmpeg/builds/packages/ffmpeg-6.0-full_build.7z)
There are differnt way to install the ffmpeg binaries (ffmpeg.exe, ffplay.exe, and ffprobe.exe). The easiest way is to put them here:
%LOCALAPPDATA%\Programs\Python\Python311
### Linux
**Please check the [dependencies](https://devguide.python.org/getting-started/setup-building/#install-dependencies) beforehand!!!**
For Fedora:
Honestly, I didn't get this depencency thing working. And I couldn't find a solution. However, I am installing a huge amount of packages anyway such that the required stuff is part of it. :-)
```shell
sudo dnf install dnf-plugins-core # install this to use 'dnf builddep'
sudo dnf builddep python3
```
Python installation (after the dependencies are solved):
```shell
mkdir PySource
cd PySource
wget https://www.python.org/ftp/python/3.12.5/Python-3.12.5.tgz
tar -xvzf Python-3.12.5.tgz
cd Python-3.12.5
./configure --prefix=/home/[YOURUSERNAME]/P3.12 --enable-optimizations
make -j 10
make install
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install --upgrade pip
```
#### Bash (.bash_profile)
```shell
alias pyhton3=/home/[YOURUSERNAME]/P3.12/bin/python3
alias pyhton=/home/[YOURUSERNAME]/P3.12/bin/python3
alias ipyhton=/home/[YOURUSERNAME]/P3.12/bin/ipython
alias ipyhton3=/home/[YOURUSERNAME]/P3.12/bin/ipython
alias python3=/home/[YOURUSERNAME]/P3.12/bin/python3
alias python=/home/[YOURUSERNAME]/P3.12/bin/python3
alias ipython=/home/[YOURUSERNAME]/P3.12/bin/ipython
alias ipython3=/home/[YOURUSERNAME]/P3.12/bin/ipython
alias pip3=/home/[YOURUSERNAME]/P3.12/bin/pip3
alias pip=/home/[YOURUSERNAME]/P3.12/bin/pip3
```
And add **/home/[YOURUSERNAME]/P3.12/bin** to the **export PATH=** command.
## Numba
{: .topic-optional}
This is an optional topic!
The question is: Is numba broken in the moment or not? First we install numpy and then numba. We will observe if numba tried to change the numpy version.
### Windows
```shell
pip install numpy
```
```shell
pip install numba
```
If so then you have to decide if you want to remove numba and the downgraded numpy version before continuing. I would remove it!
```shell
pip uninstall numpy numba
```
### Linux
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip install numpy
```
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip install numba
```
If so then you have to decide if you want to remove numba and the downgraded numpy version before continuing. I would remove it!
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip uninstall numpy numba
```
|Package||
|---|---|
|numba|[Numba is an open source JIT compiler that translates a subset of Python and NumPy code into fast machine code.](https://numba.pydata.org/)|
## Basic Packages you want to install
### Windows
```shell
pip3 install numpy scipy pandas flake8 pep8-naming black matplotlib seaborn ipython jupyterlab mypy dataclasses-json dataconf ipympl pywavelets scikit-image opencv-python scikit-learn tqdm argh sympy jsmin pybind11 pybind11-stubgen pigar asciichartpy natsort ipykernel
```
### Linux
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install numpy scipy pandas flake8 pep8-naming black matplotlib seaborn ipython jupyterlab mypy dataclasses-json dataconf ipympl pywavelets scikit-image opencv-python scikit-learn tqdm argh sympy jsmin pybind11 pybind11-stubgen pigar asciichartpy natsort ipykernel
```
|Package||
|---|---|
|numpy|[The fundamental package for scientific computing with Python](https://numpy.org/)|
|scipy|[Fundamental algorithms for scientific computing in Python](https://scipy.org/)|
|pandas|[pandas is a fast, powerful, flexible and easy to use open source data analysis and manipulation tool](https://pandas.pydata.org/)|
|flake8|[Your Tool For Style Guide Enforcement](https://flake8.pycqa.org/en/latest/)|
|pep8-naming|[Check your code against PEP 8 naming conventions](https://pypi.org/project/pep8-naming/)|
|black|[The uncompromising code formatter](https://black.readthedocs.io/en/stable/index.html)|
|matplotlib|[Visualization with Python](https://matplotlib.org/)|
|seaborn|[seaborn: statistical data visualization](https://seaborn.pydata.org/)|
|ipython|[IPython provides a rich architecture for interactive computing](https://ipython.org/)|
|jupyterlab|[JupyterLab is the latest web-based interactive development environment for notebooks, code, and data.](https://jupyter.org/)|
|mypy|[Mypy is an optional static type checker for Python that aims to combine the benefits of dynamic (or "duck") typing and static typing.](http://mypy-lang.org/")|
|dataclasses-json|[Easily serialize Data Classes to and from JSON](https://github.com/lidatong/dataclasses-json)|
|dataconf|[Simple dataclasses configuration management for Python with hocon/json/yaml/properties/env-vars/dict support](https://github.com/zifeo/dataconf)|
|ipympl|[Matplotlib Jupyter Integration](https://github.com/matplotlib/ipympl)|
|pywavelets|[PyWavelets is open source wavelet transform software for Python.](https://pywavelets.readthedocs.io/en/latest/)|
|scikit-learn|[Simple and efficient tools for predictive data analysis](https://scikit-learn.org/)|
|scikit-image|[Image processing in Python](https://scikit-image.org/)|
|opencv-python|[Open Source Computer Vision Library](https://opencv.org/)|
|tqdm|[A Fast, Extensible Progress Bar for Python and CLI](https://github.com/tqdm/tqdm)|
|argh|[Building a command-line interface?](https://pythonhosted.org/argh/) Found yourself uttering “argh!” while struggling with the API of argparse? Dont want to lose its power but dont need the complexity?|
|sympy|[SymPy is a Python library for symbolic mathematics.](https://www.sympy.org/en/index.html)|
|jsmin|[JavaScript minifier](https://github.com/tikitu/jsmin/)|
|pybind11|[Seamless operability between C++11 and Python](https://github.com/pybind/pybind11)|
|pybind11-stubgen|For mypy|
|pigar|[A tool to generate requirements.txt for Python project, and more than that.](https://github.com/damnever/pigar)|
|asciichartpy|[Nice-looking lightweight console ASCII line charts](https://github.com/kroitor/asciichart)|
|natsort|[Simple yet flexible natural sorting in Python.](https://github.com/SethMMorton/natsort)|
|ipykernel|IPython Kernel for Jupyter|
### PyTorch
[Check here](https://pytorch.org/get-started/locally/#start-locally) for a installation configurator.
**Note: Even if you don't want to use TensorFlow, you want to install it too due to the tensorboard package.** Tensorboard allows to track the progress during learning.
#### Windows
##### CPU only
```shell
pip3 install torch torchvision torchaudio torchtext
```
##### NVidia GPU
```shell
pip3 install torch torchvision torchaudio torchtext --index-url https://download.pytorch.org/whl/cu121
```
#### Linux
##### CPU only
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install torch torchvision torchaudio torchtext --index-url https://download.pytorch.org/whl/cpu
```
##### NVidia GPU
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install torch torchvision torchaudio torchtext
```
|Package||
|---|---|
|torch|[PyTorch is a Python package that provides two high-level features: a. Tensor computation (like NumPy) with strong GPU acceleration b. Deep neural networks built on a tape-based autograd system](https://pytorch.org/)|
|torchvision|[The torchvision package consists of popular datasets, model architectures, and common image transformations for computer vision.](https://github.com/pytorch/vision)|
|torchaudio|[The aim of torchaudio is to apply PyTorch to the audio domain.](https://github.com/pytorch/audio)|
|torchtext|[Models, data loaders and abstractions for language processing, powered by PyTorch](https://github.com/pytorch/text)|
### TensorFlow
#### Windows
##### CPU only
```shell
pip3 install tensorflow
```
##### NVidia GPU
```shell
pip3 install tensorflow[and-cuda]
```
#### Linux
##### CPU only
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install tensorflow
```
##### NVidia GPU
```shell
cd /home/[YOURUSERNAME]/P3.12/bin
./pip3 install tensorflow[and-cuda]
```
|Package||
|---|---|
|tensorflow|[TensorFlow is an open source software library for high performance numerical computation. Its flexible architecture allows easy deployment of computation across a variety of platforms (CPUs, GPUs, TPUs), and from desktops to clusters of servers to mobile and edge devices.](https://www.tensorflow.org/)|