Skip to main content

Wrappers for using LHCb CVMFS conda installations

Project description

LHCb Conda Wrappers

Wrapper scripts for providing access to conda environments which are installed on CVMFS.

Standard Usage

NOTE: Currently this is only available in the unstable flavour of the LHCb environment. See here for how to change flavour.

The main environment provided is named default and aims to provide most software tools that will be needed for analaysis that is performed outside of the standard LHCb software stack. This includes a recent version of Python 3, ROOT, Snakemake, jupyterlab, matplotlib, scikit-learn, tensorflow and many more.

Basic usage

Environments can be activated using the lb-conda command which works similarly to lb-run. To launch a bash shell inside the default environment run:

$ lb-conda default bash
[bash-5.0]$ python --version
Python 3.7.6
[bash-5.0]$ root --version
ROOT Version: 6.20/04
Built for linuxx8664gcc on Apr 20 2020, 15:03:00
From @

Alternative commands can be ran directly using:

$ lb-conda default python -c 'import math; print(math.sqrt(2))'
1.4142135623730951

Versioning

Occasionally new versions of the default environment will be made to add new packages and generally keep it up-to-date. If you wish to use an older version you can list the available versions using:

$ lb-conda --list default
2019-12-26
2020-05-14

The 2020-05-14 version can explicitly chosen using:

$ lb-conda default/2020-05-14 bash

Customising

As the conda environment used is installed on the read-only CVMFS filesystem the usual pip install and conda install commands will not work. Two options are provided to allow environments to be customised.

Installing additional python packages

This is the preferred option as most data will be kept on CVMFS and works by creating a virtual environment on top of the CVMFS installed environment. It is however limited to only allowing pip installed Python packages and locally built software.

To create the virtual environment in a local directory ("my-local-directory") run

$ lb-conda-dev virtual-env default my-local-directory

The environment can now be used similarly to lb-conda default using the run script:

$ my-local-directory/run bash

To upgrade the uproot Python package run:

$ my-local-directory/run bahs
[bash-5.0]$ python -c 'import uproot; print(uproot.__version__)'
3.11.6  # <- Original version
[bash-5.0]$ pip install --upgrade uproot
Collecting uproot
# Truncated output
Successfully installed uproot-3.11.7
[bash-5.0]$ python -c 'import uproot; print(uproot.__version__)'
3.11.7  # <- New version

To install a locally compiled application in the virtual environment you should set the install prefix to be the absolute path to your local directory. How this is done will depend on the build system used by the specific application.

Fully customising an environment

This option is discouraged, especially when running on AFS/EOS as it will result in a large amount of data and many small files being copied to your local directory. It does however allow you to completely clone the environment and then make any modifications.

TODO: This is not currently documented...

Advanced usage

Using non-default environments

To see the full list of available environments run:

$ lb-conda --list
B2OC/b2dstdspi-gpu
B2OC/b2dstdspi
Charm/D02KsHH
Semilep/rdst
default
DPA/analysis-productions-certification
DPA/analysis-productions

A custom environment can then be chosen using it's name:

$ lb-conda Charm/D02KsHH python --version
Python 3.6.5 :: Anaconda, Inc.

Suggesting new or upgraded packages in the default environment

Please open an issue here explaining what should be added/upgraded and why.

Adding new environments to CVMFS

This is not yet widely available available. If you have a strong reason for lease open an issue here to explaing what your requirements are.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

LbCondaWrappers-0.0.5.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

LbCondaWrappers-0.0.5-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file LbCondaWrappers-0.0.5.tar.gz.

File metadata

  • Download URL: LbCondaWrappers-0.0.5.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for LbCondaWrappers-0.0.5.tar.gz
Algorithm Hash digest
SHA256 b2d1756c356e710dbe2676d954913dfdb0226061fefda567fd7fc0d38302e5fc
MD5 94e198ed8d6a3d36bd85c9a935f9f6e6
BLAKE2b-256 c7a3ca983b1e385bb73854bb6ff8bf8cbe1e7aa4062d4ea5279ea0a2b9c7f94e

See more details on using hashes here.

File details

Details for the file LbCondaWrappers-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: LbCondaWrappers-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for LbCondaWrappers-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0cd88a9afe96e76c665580b20b69d78211d8885b60b4602ae3728ae4eac751cd
MD5 a5f4f63e2e13f5f6277d8f3d3b773dd3
BLAKE2b-256 279446f6847103d5b0b4ef23115ba7202c2d80efe6eccf3fab14090f9d1c714b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page