Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README to reflect the changes of the install process #89

Merged
merged 2 commits into from
May 26, 2020
Merged

Update README to reflect the changes of the install process #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b26064
Update README to reflect the changes of what is installed where
tmadlener May 14, 2020
37364cb
Take into account differences in install paths for RedHat systems
tmadlener May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 29 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Please submit feature requests and bugs to
- [Advanced Topics](./doc/advanced_topics.md)
- [Contributing](./doc/contributing.md)

Browse the API documentation created with Doxygen at
<!-- Browse the API documentation created with Doxygen at -->

[http://fccsw.web.cern.ch/fccsw/podio/index.html](http://fccsw.web.cern.ch/fccsw/podio/index.html).
<!-- [http://fccsw.web.cern.ch/fccsw/podio/index.html](http://fccsw.web.cern.ch/fccsw/podio/index.html). -->

## Prerequisites

Expand Down Expand Up @@ -90,23 +90,43 @@ To see a list of options, do this in the build-directory:

The examples are for creating a file "example.root",

../install/tests/write
tests/write

reading it again in C++,
and reading it again in C++,

../install/tests/read
tests/read

and reading it again in python,
It is also possible to read the file again using the
[`tests/read.py`](tests/read.py) script. Make sure to have run `init.sh`
and `env.sh` first. Additionally you have to make `ROOT` aware of
`libTestDataModel.so` to be able to read in the data types defined there. There
are two ways to do that. First it is possible to add the directory to the
`LD_LIBRARY_PATH`

python ../tests/read.py
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:$(pwd)/tests

Secondly it is also possible to explicitly load the library via `ROOT` in the
script by adding the following lines *after* the imports from `__future__`

```python
import os
BUILD_PATH = os.getcwd()

import ROOT
ROOT.gSystem.Load(os.path.join(BUILD_PATH, 'tests/libTestDataModel.so'))
```

Either of the two versions allows you to now read the `example.root` file again
using

python ../tests/read.py

## Installing using SPACK

A recipe for building podio is included with the [spack package manager](https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/podio/package.py), so podio can also installed with:

```
spack install podio

```

Note that if you do not have any previous installations or registered system packages, this will compile ROOT and all its dependencies, which may be time-consuming.
Expand All @@ -131,6 +151,6 @@ The generation script has the following additional options:
- `--dryrun` (`-d`): Only run the generation logic and validate yaml, do not write files to disk

## Running tests
After compilation and installation (!) you can run rudimentary tests with
After compilation you can run rudimentary tests with

make test
9 changes: 7 additions & 2 deletions env.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,19 @@ unamestr=`uname`
if [[ "$unamestr" == 'Linux' ]]; then
echo $LD_LIBRARY_PATH | grep $PODIO/lib >& /dev/null
if [ $? == "1" ]; then
export LD_LIBRARY_PATH=$PODIO/tests:$PODIO/lib:$LD_LIBRARY_PATH
# RedHat based put the libraries into lib64
if [ -d $PODIO/lib64 ]; then
export LD_LIBRARY_PATH=$PODIO/lib64:$LD_LIBRARY_PATH
else
export LD_LIBRARY_PATH=$PODIO/lib:$LD_LIBRARY_PATH
fi
fi
elif [[ "$unamestr" == 'Darwin' ]]; then
# This currenty does not work on OS X as DYLD_LIBRARY_PATH is ignored
# in recent OS X versions
echo $DYLD_LIBRARY_PATH | grep $PODIO/lib >& /dev/null
if [ $? == "1" ]; then
export DYLD_LIBRARY_PATH=$PODIO/tests:$PODIO/lib:$DYLD_LIBRARY_PATH
export DYLD_LIBRARY_PATH=$PODIO/lib:$DYLD_LIBRARY_PATH
fi
fi
echo $PYTHONPATH | grep $PODIO/python >& /dev/null
Expand Down