Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.

Commit

Permalink
fix all TOCs and make new version
Browse files Browse the repository at this point in the history
  • Loading branch information
jpivarski committed Jun 6, 2019
1 parent 39651bf commit cf7d6b1
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ Install uproot like any other Python package:

.. code-block:: bash
pip install uproot # maybe with sudo or --user, or in virtualenv
pip install uproot # maybe with sudo or --user, or in virtualenv
or install with `conda <https://conda.io/en/latest/miniconda.html>`__:

.. code-block:: bash
conda config --add channels conda-forge # if you haven't added conda-forge already
conda config --add channels conda-forge # if you haven't added conda-forge already
conda install uproot
The pip installer automatically installs strict dependencies; the conda installer also installs optional dependencies (except for Pandas).
Expand Down Expand Up @@ -83,7 +83,7 @@ Tutorial

Run `this tutorial <https://mybinder.org/v2/gh/scikit-hep/uproot/master?urlpath=lab/tree/binder%2Ftutorial.ipynb>`__ on Binder.

**Table of contents:**
**Tutorial contents:**

* `Introduction <#introduction>`__
* `What is uproot? <#what-is-uproot>`__
Expand Down
58 changes: 58 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,72 @@ def get_description():
Run `that tutorial <https://mybinder.org/v2/gh/scikit-hep/uproot/master?urlpath=lab/tree/binder%2Ftutorial.ipynb>`__ on Binder.
**Tutorial contents:**
* `Introduction <https://github.com/scikit-hep/uproot#introduction>`__
* `What is uproot? <https://github.com/scikit-hep/uproot#what-is-uproot>`__
* `Exploring a file <https://github.com/scikit-hep/uproot#exploring-a-file>`__
* `Compressed objects in ROOT files <https://github.com/scikit-hep/uproot#compressed-objects-in-root-files>`__
- `Exploring a TTree <https://github.com/scikit-hep/uproot#exploring-a-ttree>`__
- `Some terminology <https://github.com/scikit-hep/uproot#some-terminology>`__
* `Reading arrays from a TTree <https://github.com/scikit-hep/uproot#reading-arrays-from-a-ttree>`__
* `Caching data <https://github.com/scikit-hep/uproot#caching-data>`__
- `Automatically managed caches <https://github.com/scikit-hep/uproot#automatically-managed-caches>`__
- `Caching at all levels of abstraction <https://github.com/scikit-hep/uproot#caching-at-all-levels-of-abstraction>`__
* `Lazy arrays <https://github.com/scikit-hep/uproot#lazy-arrays>`__
- `Lazy array of many files <https://github.com/scikit-hep/uproot#lazy-array-of-many-files>`__
- `Lazy arrays with caching <https://github.com/scikit-hep/uproot#lazy-arrays-with-caching>`__
- `Lazy arrays as lightweight skims <https://github.com/scikit-hep/uproot#lazy-arrays-as-lightweight-skims>`__
- `Lazy arrays in Dask <https://github.com/scikit-hep/uproot#lazy-arrays-in-dask>`__
* `Iteration <https://github.com/scikit-hep/uproot#iteration>`__
- `Filenames and entry numbers while iterating <https://github.com/scikit-hep/uproot#filenames-and-entry-numbers-while-iterating>`__
- `Limiting the number of entries to be read <https://github.com/scikit-hep/uproot#limiting-the-number-of-entries-to-be-read>`__
- `Controlling lazy chunk and iteration step sizes <https://github.com/scikit-hep/uproot#controlling-lazy-chunk-and-iteration-step-sizes>`__
- `Caching and iteration <https://github.com/scikit-hep/uproot#caching-and-iteration>`__
* `Changing the output container type <https://github.com/scikit-hep/uproot#changing-the-output-container-type>`__
* `Filling Pandas DataFrames <https://github.com/scikit-hep/uproot#filling-pandas-dataframes>`__
* `Selecting and interpreting branches <https://github.com/scikit-hep/uproot#selecting-and-interpreting-branches>`__
- `TBranch interpretations <https://github.com/scikit-hep/uproot#tbranch-interpretations>`__
- `Reading data into a preexisting array <https://github.com/scikit-hep/uproot#reading-data-into-a-preexisting-array>`__
- `Passing many new interpretations in one call <https://github.com/scikit-hep/uproot#passing-many-new-interpretations-in-one-call>`__
- `Multiple values per event: fixed size arrays <https://github.com/scikit-hep/uproot#multiple-values-per-event-fixed-size-arrays>`__
- `Multiple values per event: leaf-lists <https://github.com/scikit-hep/uproot#multiple-values-per-event-leaf-lists>`__
- `Multiple values per event: jagged arrays <https://github.com/scikit-hep/uproot#multiple-values-per-event-jagged-arrays>`__
- `Jagged array performance <https://github.com/scikit-hep/uproot#jagged-array-performance>`__
- `Special physics objects: Lorentz vectors <https://github.com/scikit-hep/uproot#special-physics-objects-lorentz-vectors>`__
- `Variable-width values: strings <https://github.com/scikit-hep/uproot#variable-width-values-strings>`__
- `Arbitrary objects in TTrees <https://github.com/scikit-hep/uproot#arbitrary-objects-in-ttrees>`__
- `Doubly nested jagged arrays (i.e. std::vector<std::vector<T>>) <https://github.com/scikit-hep/uproot#doubly-nested-jagged-arrays-ie-stdvectorstdvectort>`__
* `Parallel array reading <https://github.com/scikit-hep/uproot#parallel-array-reading>`__
* `Histograms, TProfiles, TGraphs, and others <https://github.com/scikit-hep/uproot#histograms-tprofiles-tgraphs-and-others>`__
* `Creating and writing data to ROOT files <https://github.com/scikit-hep/uproot#creating-and-writing-data-to-root-files>`__
- `Writing histograms <https://github.com/scikit-hep/uproot#writing-histograms>`__
- `Writing TTrees <https://github.com/scikit-hep/uproot#writing-ttrees>`__
Reference documentation
=======================
* `Opening files <http://uproot.readthedocs.io/en/latest/opening-files.html>`__
- `uproot.open <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-open>`__
- `uproot.xrootd <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-xrootd>`__
- `uproot.http <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-http>`__
- `uproot.iterate <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-iterate>`__
- `uproot.pandas.iterate <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-pandas-iterate>`__
- `uproot.lazyarray(s) <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-lazyarray-and-lazyarrays>`__
- `uproot.daskarray/daskframe <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-daskarray-and-daskframe>`__
- `uproot.numentries <http://uproot.readthedocs.io/en/latest/opening-files.html#uproot-numentries>`__
* `ROOT I/O <http://uproot.readthedocs.io/en/latest/root-io.html>`__
Expand Down
2 changes: 1 addition & 1 deletion uproot/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import re

__version__ = "3.6.3"
__version__ = "3.6.4"
version = __version__
version_info = tuple(re.split(r"[-\.]", __version__))

Expand Down

0 comments on commit cf7d6b1

Please sign in to comment.