Commit a6ed270e authored by Ben Couturier's avatar Ben Couturier
Browse files

Converted README to rst

parent 1ebe1cb6
Pipeline #2952687 passed with stage
in 42 seconds
# Analysis Production Data
*EXPERIMENTAL* prototype of python module to fulfill:
https://gitlab.cern.ch/lhcb-dpa/project/-/issues/134
# Design
## Analysis Production information endpoint
This module allows downloading and using Analysis Production information from the endpoint *https://lbap.app.cern.ch/*
Details about the endpoint can be found at:
https://lbap.app.cern.ch/docs#/stable
BEWARE: The endpoint is experimental and can be interrupted at any time.
## Credentials
This module uses a copy of [auth-get-sso-cookie](https://gitlab.cern.ch/authzsvc/tools/auth-get-sso-cookie.git) to be able to authenticate against the CERN SSO system using Kerberos credentials.
N.B. CERN users PRIMARY ACCOUNTs should be used, secondary accounts cannot access the API.
# Usage
## From python
The python module allows interacting from analysis scripts, doing e.g.
```
In [8]: import apd
In [9]: datasets = apd.AnalysisData("SL", "RDs")
In [10]: datasets(year="2012")
Out[10]:
['root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000001_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000002_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000003_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000004_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000005_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000001_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000002_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000003_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000004_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000005_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000006_1.bsntuple_mc.root']
In [11]:
```
## Command line
```
$ apd-list-pfns SL RDs --year=2011 --year=2016 --polarity=magdown
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000001_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000002_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000003_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000001_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000002_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000003_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000004_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000005_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000006_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000007_1.bsntuple_mc.root
```
The *apd-cache* command allows caching the Analysis metadata to a specific location.
Analysis Production Data
========================
*EXPERIMENTAL* prototype of python module to fulfill:
https://gitlab.cern.ch/lhcb-dpa/project/-/issues/134
Design
======
Analysis Production information endpoint
----------------------------------------
This module allows downloading and using Analysis Production information
from the endpoint *https://lbap.app.cern.ch/*
Details about the endpoint can be found at:
https://lbap.app.cern.ch/docs#/stable
BEWARE: The endpoint is experimental and can be interrupted at any time.
Credentials
-----------
This module uses a copy of
`auth-get-sso-cookie <https://gitlab.cern.ch/authzsvc/tools/auth-get-sso-cookie.git>`__
to be able to authenticate against the CERN SSO system using Kerberos
credentials.
N.B. CERN users PRIMARY ACCOUNTs should be used, secondary accounts
cannot access the API.
Usage
=====
From python
-----------
The python module allows interacting from analysis scripts, doing e.g.
::
In [8]: import apd
In [9]: datasets = apd.AnalysisData("SL", "RDs")
In [10]: datasets(year="2012")
Out[10]:
['root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000001_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000002_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000003_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000004_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110970/0000/00110970_00000005_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000001_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000002_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000003_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000004_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000005_1.bsntuple_mc.root',
'root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2012/BSNTUPLE_MC.ROOT/00110972/0000/00110972_00000006_1.bsntuple_mc.root']
In [11]:
Command line
------------
::
$ apd-list-pfns SL RDs --year=2011 --year=2016 --polarity=magdown
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000001_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000002_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2011/BSNTUPLE_MC.ROOT/00110968/0000/00110968_00000003_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000001_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000002_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000003_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000004_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000005_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000006_1.bsntuple_mc.root
root://eoslhcb.cern.ch//eos/lhcb/grid/prod/lhcb/MC/2016/BSNTUPLE_MC.ROOT/00110984/0000/00110984_00000007_1.bsntuple_mc.root
The *apd-cache* command allows caching the Analysis metadata to a
specific location.
......@@ -5,7 +5,7 @@
[metadata]
name = apd
description = Tool to access the Analysis production Data
long_description = file: README.md
long_description = file: README.rst
license = BSD-3-Clause
classifiers =
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment