Skip to content

Commit

Permalink
Getting started (#42)
Browse files Browse the repository at this point in the history
* add notebook to get started with example inputs

* add badges to binder and SWAN

* add SWAN/binder links to README

* make abstract LateX

* move notebook and example inputs

* update README with updated binder link, ignore output from examples

* add reading combine ntuple example notebook

* update mail address to egroup

* add example notebook on reading histograms

* move notebooks to examples

* add image and thumbnail
  • Loading branch information
clelange authored and AndreasAlbert committed Jun 22, 2018
1 parent 9d95ec6 commit fb74bc9
Show file tree
Hide file tree
Showing 15 changed files with 1,093 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# output from examples
examples/submission.tar.gz
examples/example_output/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@ Library for getting your data into HEPData
pip install hepdata_lib
```

## Getting started

For using `hepdata_lib`, you don't even need to install it, but can use the [binder](https://mybinder.org/) or [SWAN](https://swan.cern.ch/) (CERN-only) services using one of the buttons below and following the instructions in the notebook with name [Getting_started](examples/Getting_started.ipynb):

[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/clelange/hepdata_lib/master?filepath=examples/Getting_started.ipynb)
[![SWAN](https://swanserver.web.cern.ch/swanserver/images/badge_swan_white_150.png)](https://cern.ch/swanserver/cgi-bin/go?projurl=https://mybinder.org/v2/gh/clelange/hepdata_lib.git)

## Further examples

There are a few more examples available that can directly be run using the [binder](https://mybinder.org/) links below or using [SWAN](https://swan.cern.ch/) (CERN-only) and selecting the corresponding notebook manually:

- [Reading in text files](examples/Getting_started.ipynb) [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/clelange/hepdata_lib/master?filepath=examples/Getting_started.ipynb)
- [Reading in a CMS combine ntuple](examples/combine_limits.ipynb) [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/clelange/hepdata_lib/master?filepath=examples/combine_limits.ipynb)
- [Reading in ROOT histograms](examples/reading_histograms.ipynb) [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/clelange/hepdata_lib/master?filepath=examples/reading_histograms.ipynb)

## External dependencies

- [ROOT](https://root.cern.ch)
Expand Down
Loading

0 comments on commit fb74bc9

Please sign in to comment.