Skip to main content

Library for getting your data into HEPData

Project description

hepdata_lib

DOI PyPI version conda-forge version Actions Status Coverage Status Documentation Status Docker image

Library for getting your data into HEPData

This code works with Python 3.6, 3.7, 3.8, 3.9, 3.10, 3.11 or 3.12.

Installation

It is highly recommended you install hepdata_lib into a virtual environment.

python -m pip install hepdata_lib

Alternatively, install from conda-forge using a conda ecosystem package manager:

conda install --channel conda-forge hepdata-lib

If you are not sure about your Python environment, please also see below how to use hepdata_lib in a Docker or Apptainer container. The use of Apptainer is recommended when working on typical HEP computing clusters such as CERN LXPLUS.

Getting started

For using hepdata_lib, you don't even need to install it, but can use the binder or SWAN (CERN-only) services using one of the buttons below:

Binder SWAN

You can also use the Docker image (recommended when working on local machine):

docker run --rm -it -p 8888:8888 -v ${PWD}:/home/hepdata ghcr.io/hepdata/hepdata_lib:latest

And then point your browser to http://localhost:8888 and use the token that is printed out. The output will end up in your current working directory (${PWD}).

If you prefer a shell, instead run:

docker run --rm -it -p 8888:8888 -v ${PWD}:/home/hepdata ghcr.io/hepdata/hepdata_lib:latest bash

If on CERN LXPLUS or anywhere else where there is Apptainer available but not Docker, you can still use the docker image.

If CVMFS (specifically /cvmfs/unpacked.cern.ch/) is available:

export APPTAINER_CACHEDIR="/tmp/$(whoami)/apptainer"
apptainer shell -B /afs -B /eos /cvmfs/unpacked.cern.ch/ghcr.io/hepdata/hepdata_lib:latest

If CVMFS is not available:

export APPTAINER_CACHEDIR="/tmp/$(whoami)/apptainer"
apptainer shell -B /afs -B /eos docker://ghcr.io/hepdata/hepdata_lib:latest bash

Unpacking the image can take a few minutes the first time you use it. Please be patient. Both EOS and AFS should be available and the output will be in your current working directory.

Further examples

There are a few more examples available that can directly be run using the binder links below or using SWAN (CERN-only, please use LCG release LCG_94 or later) and selecting the corresponding notebook manually:

External dependencies

Make sure that you have ROOT in your $PYTHONPATH and that the convert command is available by adding its location to your $PATH if needed.

A ROOT installation is not strictly required if your input data is not in a ROOT format, for example, if your input data is provided as text files or scikit-hep/hist histograms. Most of the hepdata_lib functionality can be used without a ROOT installation, other than the RootFileReader and CFileReader classes, and other functions of the hepdata_lib.root_utils module.

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

hepdata_lib-0.17.0.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

hepdata_lib-0.17.0-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file hepdata_lib-0.17.0.tar.gz.

File metadata

  • Download URL: hepdata_lib-0.17.0.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for hepdata_lib-0.17.0.tar.gz
Algorithm Hash digest
SHA256 22b7c188551333025394b83cbc981700ffd0ef7ddfb91708274b9ff496a54a14
MD5 84073a947d7c4ea64edbffc959db8480
BLAKE2b-256 c2d6ace70a5f6963f2a588bc4ac15b6fc2ad27b133ae30ccfb75369e6b9b81d4

See more details on using hashes here.

File details

Details for the file hepdata_lib-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: hepdata_lib-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 25.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for hepdata_lib-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc60579d87113744885c82e283039b865f61a6d280e7395d29ac7d951c0f98b
MD5 060f427eda106f66d2a00ca829a943ed
BLAKE2b-256 1824328a0070c3b3e3020f741f7518f0e626e558f8549817d62847381b96441c

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