Differences between revisions 45 and 64 (spanning 19 versions)
⇤ ← Revision 45 as of 2018-05-25 14:25:17 →
Size: 4004
Editor: pmeier
Comment:
← Revision 64 as of 2023-03-31 08:28:30 → ⇥
Size: 5645
Editor: stroth
Comment: Simpler pip configuration
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#rev 2020-09-10 bonaccos

<<TableOfContents()>>
Line 3: Line 7:
We provide as many modules as possible that come with the current Debian GNU/Linux stable release. Nevertheless, that might not be enough for your needs since you may want to use the newest version of some module or one that is not part of Debian. Furthermore you might want to use a different version of Python. We provide some modules that come with the current Debian GNU/Linux stable release, but usually this is because they are dependencies of an installed software. For python we strongly recommend to build own python environments with the desired python versions and modules.
Line 5: Line 9:
The recommended way to install additional python modules is through {{{pip}}}. Unfortunately, {{{pip}}} does not allow users to install modules in the user context. That means that you will first have to install your own version of python in your home. From that moment on, you can install modules through {{{pip}}}. Our recommended way to install such environments is trough Conda, alternatively via building an environment via `pyenv` is as well possible. Additional module can then either be installed by conda itself or trough `pip`.
Line 7: Line 11:
== Installing your own python environment with Conda ==

For a detailed overview for conda please follow to the [[Programming/Languages/Conda|Conda documentation]].
Line 10: Line 17:
{{{Pyenv}}} is a collection of tools that allow users to manage different versions of python. In the simplest case you will need it to simply get an installation of python in your user space. Using that custom python installation, you will then be able to install additional modules in a very comfortable way, since you can install them in the "system path" (which is then somewhere within your home). `Pyenv` is a collection of tools that allow users to manage different versions of python. In the simplest case you will need it to simply get an installation of python in your user space. Using that custom python installation, you will then be able to install additional modules in a very comfortable way, since you can install them in the "system path" (which is then somewhere within your home).
Line 12: Line 19:
Here is a small howto for installing python 2.7.13 in your home: Documentation on `pyenv` can be found at https://github.com/pyenv/pyenv
Line 14: Line 21:
 * Install pyenv:
 {{{
curl https://raw.githubusercontent.com/yyuu/pyenv-installer/master/bin/pyenv-installer -o pyenv-installer}}}
 Check what the script is doing and then execute it:
 {{{		 Here is a small howto for installing python 3.9.1 in your home:

 * Install pyenv: {{{#!highlight bash numbers=disable
curl https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer -o pyenv-installer
}}}
 Check what the script is doing and then execute it: {{{#!highlight bash numbers=disable
Line 22: Line 30:
 * Add the following three lines to your ~/.bash_profile:
 {{{
export PATH="$HOME/.pyenv/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"}}}		  * Add the following lines to your `~/.profile` before sourcing ~/.bashrc`: {{{#!highlight bash numbers=disable
export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init --path)"
}}}
 * In the `~/.bashrc`: {{{#!highlight bash numbers=disable
eval "$(pyenv init -)"
}}}
 * If you want to pyenv-virtualenv automatically (in the `~/.bashrc`): {{{#!highlight bash numbers=disable
eval "$(pyenv virtualenv-init -)"
}}}
Line 28: Line 42:
 * Restart your shell so the path changes take effect:
 {{{
exec $SHELL}}}		  * You need a new login shell for all settings to take effect (when logged in on a Desktop environment logoff and login again)
Line 32: Line 44:
 * Install some python version, e.g. for python 2.7.13:
 {{{
env PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install 2.7.13		  * Install some python version, e.g. for python 3.9.1: {{{#!highlight bash numbers=disable
env PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install 3.9.1
Line 38: Line 49:
 * Make sure that this new python version will be used when you run python. You only need to run this command once:
 {{{
pyenv global 2.7.13}}}		  * Make sure that this new python version will be used when you run python. You only need to run this command once: {{{#!highlight bash numbers=disable
pyenv global 3.9.1}}}
Line 42: Line 52:
 * In order to update {{{pyenv}}} run:
 {{{		  * In order to update `pyenv` run: {{{#!highlight bash numbers=disable
Line 47: Line 56:
 || Website of pyenv || https://github.com/yyuu/pyenv/ ||
 || Website of pyenv installer || https://github.com/yyuu/pyenv-installer ||
  || Website of pyenv || https://github.com/pyenv/pyenv ||
 || Website of pyenv installer || https://github.com/pyenv/pyenv-installer ||
Line 53: Line 61:
Once you installed your custom python with the explanations given above, you are ready to install additional or newer modules the easy way. The usage of {{{pip}}} is very easy. The following command installs the module {{{numpy}}}
{{{
pip install numpy}}}
while the next command would upgrade an existing installation of {{{numpy}}}
{{{
pip install --upgrade numpy}}}		 Once you installed your custom python with the explanations given above, you are ready to install additional or newer modules the easy way. The usage of `pip` is very easy. The following command installs the module `numpy`.
{{{#!highlight bash numbers=disable
pip install numpy
}}}
while the next command would upgrade an existing installation of `numpy`
{{{#!highlight bash numbers=disable
pip install --upgrade numpy
}}}
Line 60: Line 70:
For advanced usage of {{{pip}}}, please consult the manuals: http://pip.readthedocs.org/en/latest/ For advanced usage of `pip`, please consult the manuals: https://pip.pypa.io/en/latest/

=== pip cache ===
`pip` uses a cache which is by default stored under `~/.cache/pip` or `$XDG_CACHE_HOME/pip` if it is set to a non-default location. This cache tends to fill up quickly and should occasionally be cleared with
{{{#!highlight bash numbers=disable
pip cache purge
}}}
It is advisable to set the cache's location to the local scratch disk to avoid using up quota:

 1. Create a directory for the cache: {{{#!highlight bash numbers=disable
mkdir -p /scratch/$USER/pip_cache
}}}
 1. Temporarily set the environment variable to tell `pip` to use a different cache location: {{{#!highlight bash numbers=disable
export PIP_CACHE_DIR=/scratch/$USER/tmp/
}}}
 or create a configuration file to store the location permanently: {{{#!highlight bash numbers=disable
pip config set global.cache-dir /scratch/$USER/pip_cache
}}}
 1. Check if the cache location is correct: {{{#!highlight bash numbers=disable
pip cache info
}}}
Line 65: Line 95:
Here we provide some shell script snippets for installing frequently asked modules which cannot be installed through {{{pip}}}. These scripts just provide an example installation. You might have to adapt some paths in order to make the module work correctly with the version of python you are using (e.g. if you run your custom python provided through {{{pyenv}}}). Here we provide some shell script snippets for installing frequently asked modules which cannot be installed through `pip`. These scripts just provide an example installation. You might have to adapt some paths in order to make the module work correctly with the version of python you are using (e.g. if you run your custom python provided through `pyenv`).
Line 68: Line 98:
{{{#!highlight bash {{{#!highlight bash numbers=disable

Contents

  1. Python
    1. Installing your own python environment with Conda
    2. Installing your own python versions with pyenv
      1. Documentation of pyenv
    3. Installation of additional or newer modules with pip
      1. pip cache
    4. Installation of Python modules that are not available in the archives of pip
      1. nlopt

Python

We provide some modules that come with the current Debian GNU/Linux stable release, but usually this is because they are dependencies of an installed software. For python we strongly recommend to build own python environments with the desired python versions and modules.

Our recommended way to install such environments is trough Conda, alternatively via building an environment via pyenv is as well possible. Additional module can then either be installed by conda itself or trough pip.

Installing your own python environment with Conda

For a detailed overview for conda please follow to the Conda documentation.

Installing your own python versions with pyenv

Pyenv is a collection of tools that allow users to manage different versions of python. In the simplest case you will need it to simply get an installation of python in your user space. Using that custom python installation, you will then be able to install additional modules in a very comfortable way, since you can install them in the "system path" (which is then somewhere within your home).

Documentation on pyenv can be found at https://github.com/pyenv/pyenv

Here is a small howto for installing python 3.9.1 in your home:

  • Install pyenv: 

    curl https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer -o pyenv-installer

    Check what the script is doing and then execute it: 

    bash ./pyenv-installer
    You can remove the installer file afterwards.

  • Add the following lines to your ~/.profile before sourcing ~/.bashrc`: 

    export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init --path)"

  • In the ~/.bashrc: 

    eval "$(pyenv init -)"

  • If you want to pyenv-virtualenv automatically (in the ~/.bashrc): 

    eval "$(pyenv virtualenv-init -)"
  • You need a new login shell for all settings to take effect (when logged in on a Desktop environment logoff and login again)

  • Install some python version, e.g. for python 3.9.1: 

    env PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install 3.9.1
pyenv rehash

    Note, that settting of PYTHON_CONFIGURE_OPTS="--enable-shared" is needed if you need to link against the libpython shared library.

  • Make sure that this new python version will be used when you run python. You only need to run this command once: 

    pyenv global 3.9.1

  • In order to update pyenv run: 

    pyenv update

Documentation of pyenv

Installation of additional or newer modules with pip

Once you installed your custom python with the explanations given above, you are ready to install additional or newer modules the easy way. The usage of pip is very easy. The following command installs the module numpy. 

pip install numpy

while the next command would upgrade an existing installation of numpy 

pip install --upgrade numpy

For advanced usage of pip, please consult the manuals: https://pip.pypa.io/en/latest/

pip cache

pip uses a cache which is by default stored under ~/.cache/pip or $XDG_CACHE_HOME/pip if it is set to a non-default location. This cache tends to fill up quickly and should occasionally be cleared with 

pip cache purge

It is advisable to set the cache's location to the local scratch disk to avoid using up quota:

  1. Create a directory for the cache: 

    mkdir -p /scratch/$USER/pip_cache

  2. Temporarily set the environment variable to tell pip to use a different cache location: 

    export PIP_CACHE_DIR=/scratch/$USER/tmp/

    or create a configuration file to store the location permanently: 

    pip config set global.cache-dir /scratch/$USER/pip_cache

  3. Check if the cache location is correct: 

    pip cache info

Installation of Python modules that are not available in the archives of pip

Here we provide some shell script snippets for installing frequently asked modules which cannot be installed through pip. These scripts just provide an example installation. You might have to adapt some paths in order to make the module work correctly with the version of python you are using (e.g. if you run your custom python provided through pyenv).

nlopt

#!/bin/bash

# Installation script for nlopt library

VERSION=2.3
INSTALLDIR=$HOME/.local
BUILDDIR=/scratch/$USER/nlopt

mkdir -p $BUILDDIR
cd $BUILDDIR

wget "http://ab-initio.mit.edu/nlopt/nlopt-${VERSION}.tar.gz"
tar -xvvzkf nlopt-${VERSION}.tar.gz
cd nlopt-${VERSION}

./configure \
        --enable-shared \
        --prefix=$INSTALLDIR \
        OCT_INSTALL_DIR=$INSTALLDIR/octave/oct \
        M_INSTALL_DIR=$INSTALLDIR/octave/m/ \
        MEX_INSTALL_DIR=$INSTALLDIR/mex \
        GUILE_INSTALL_DIR=$INSTALLDIR/guile

make
make install

CategoryLXSW

Programming/Languages/Python (last edited 2023-11-06 08:33:58 by stroth)