ejpm 0.0.4

EIC Jana Package Manager

ejpm

ejpm stands for e^JANA packet manager helper

The goal of ejpm is to provide easy experience of:

• installing e^JANA reconstruction framework and supporting packages
• uify installation in different environments: various operating systems, docker images, etc.

The secondary goal is to help users with e^JANA plugin development cycle.

Motivation

TL;DR; Cern ROOT, Geant, and other scientific packages are crappy, not supported by major Linux distros so everybody have to reinvent the wheel (and we do) to include them (and dependencies) in a software chain

why ejpm is here (and a pain, it tries to resolve) - is that there is no standard convention in our field of how all dependent packages are installed. Some packages (like eigen, xerces, etc.) are usually supported by OS maintainers, while others (Cern ROOT, Geant4) are usually built by users or other packet managers and could be located anywhere.

It should be as easy as:

> ejpm find all            # try to automatically find dependent packets
> ejpm --top-dir=/opt/eic  # set where to install missing packets
> ejpm install all         # build and install missing packets

It also gives a possibility to fine control over dependencies

> ejpm set root /opt/root6_04_16  # manually add cern ROOT location to use
> ejpm rebuild jana && ejpm rebuild ejana  # rebuild packets after it 

What ejpm is not:

1. It is not a real package manager, which automatically solves dependencies
2. ejpm is not a requirment for e^JANA. It is not a part of e^JANA build system and one can compile and install e^JANA without ejpm

• A database stores the current state of installation and location of stored packets.
• Package installation contexts holds information of configuration and steps needed to install a package
• CLI (command line interface)- provides users with commands to manipulate packets

Users are pretty much encouraged to change the code and everything is done here to be user-change-friendly

Installation

Regular (TL;DR;):

pip install ejpm

JLab specific matters
There could be Root Certificate related problems on JLab machines (more details are in the end):

python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org ejpm

For lvl1&2 machines, there is a python installations that have pip :

/apps/python/     # All pythons there have pip and etc
/apps/anaconda/   # Moreover, there is anaconda (python with all major math/physics libs) 

But... there is no pip:
Install it!

sudo easy_install pip

But... there is no easy_install!
Install it!

sudo yum install python-setuptools python-setuptools-devel   # Fedora and RHEL/CentOS 
sudo apt-get install python-setuptools                       # Ubuntu and Debian
# Gentoo. I should not write this for its users, right?

For python3 it is easy_install3 and python3-setuptools

I dont have sudo privileges!

Add "--user" flag both for pip and easy_install for this. Read SO here

Manual/development installation:

TL;DR; Get EJPM, install requirements, ready:

git clone https://gitlab.com/eic/ejpm.git
pip install -r ejpm/requirements.txt
python ejpm/run_ejpm.py

'ejpm' command:

Calling python <path to ejpm>/run_ejpm.py is inconvenient! It is easy to add alias to your .bashrc (or whatever)

alias ejpm='python <path to ejpm>/run_ejpm.py'

So if you just cloned it copy/paste:

echo "alias='python `pwd`/ejpm/run_ejpm.py'" >> ~/.bashrc

requirments:

Click and appdirs are the only requirements. If you have pip do:

pip install Click appdirs

If for some reason you don't have pip, you don't know python well enough and don't want to mess with it, pips, shmips and doh... Just download and add to PYTHONPATH: this 'click' folder and some folder with appdirs.py

Environment

TL;DR; Just source it like:

source <(ejpm env)      
# or
source ~/.local/share/ejpm/env.sh    # or same with .csh

EJPM_DATA_PATH- sets the path where the configuration db.json and env.sh, env.csh are located

longer reading:

Each time you make changes to packets, EJPM generates env.sh and env.csh files, that could be found in standard apps user directory.

For linux it is in XDG_DATA_HOME:

~/.local/share/ejpm/env.sh      # sh version
~/.local/share/ejpm/env.csh     # csh version
~/.local/share/ejpm/db.json     # open it, edit it, love it

XDG is the standard POSIX paths to store applications data, configs, etc. EJPM uses XDG_DATA_HOME to store env.sh, env.csh and db.json and db.json

You can always get fresh environment with ejpm env command

ejpm env

You can directly source it like:

source <(ejpm env)

You can control where ejpm stores data by setting EJPM_DATA_PATH environment variable.

JLab certificate problems

If you get errors like:

Retrying (...) after connection broken by 'SSLError(SSLError(1, u'[SSL: CERTIFICATE_VERIFY_FAILED]...

The problem is that pip is trustworthy enough to use secure connection to get packages. And JLab is helpful enough to put its root level certificates in the middle.

1. The easiest solution is to continue use pip declaring PiPy sites as trusted:

   python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org ejpm
   

2. Or to permanently add those sites as trusted in pip.config

   [global]
   trusted-host=
       pypi.python.org
       pypi.org
       files.pythonhosted.org
   

   (The link where to find pip.config on your system)
3. You may want to be a hero and kill the dragon. The quest is to take JLab certs. Then Convert them to pem. Then add certs to pip. Then check it really works on JLab machines. And bring the dragon's head back (i.e. please, add the exact instruction to this file)