{"id":19098239,"url":"https://github.com/scikit-hep/uproot-browser","last_synced_at":"2025-04-05T16:06:28.682Z","repository":{"id":37930819,"uuid":"388316679","full_name":"scikit-hep/uproot-browser","owner":"scikit-hep","description":"A TUI viewer for ROOT files","archived":false,"fork":false,"pushed_at":"2025-03-24T19:07:58.000Z","size":299,"stargazers_count":74,"open_issues_count":11,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T15:05:27.886Z","etag":null,"topics":["python","scikit-hep"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scikit-hep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-22T03:35:43.000Z","updated_at":"2025-02-14T11:32:46.000Z","dependencies_parsed_at":"2023-12-25T21:03:01.874Z","dependency_job_id":"1ebffcba-ef6a-461b-af87-273a5d9b7c46","html_url":"https://github.com/scikit-hep/uproot-browser","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scikit-hep%2Fuproot-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scikit-hep%2Fuproot-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scikit-hep%2Fuproot-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scikit-hep%2Fuproot-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scikit-hep","download_url":"https://codeload.github.com/scikit-hep/uproot-browser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361686,"owners_count":20926643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","scikit-hep"],"created_at":"2024-11-09T03:44:45.042Z","updated_at":"2025-04-05T16:06:28.627Z","avatar_url":"https://github.com/scikit-hep.png","language":"Python","funding_links":[],"categories":["Library"],"sub_categories":[],"readme":"\u003cimg alt=\"uproot-browser\" width=\"100%\" src=\"https://raw.githubusercontent.com/scikit-hep/uproot-browser/main/docs/_images/uproot-browser-logo.png\"/\u003e\n\n# uproot-browser\n\n[![Actions Status][actions-badge]][actions-link]\n[![PyPI version][pypi-version]][pypi-link]\n[![PyPI platforms][pypi-platforms]][pypi-link]\n[![GitHub Discussion][github-discussions-badge]][github-discussions-link]\n[![Gitter][gitter-badge]][gitter-link]\n[![License][license-badge]][license-link]\n[![Scikit-HEP][sk-badge]](https://scikit-hep.org/)\n[![Conda-Forge][conda-badge]][conda-link]\n\nuproot-browser is a [plotext](https://github.com/piccolomo/plotext) based command line library in which the command line interface is provided by [Click](https://github.com/pallets/click). It is powered by [Hist](https://github.com/scikit-hep/hist) and it's TUI is put together by [Textual](https://github.com/Textualize/textual). Its aim is to enable a user to browse and look inside a ROOT file, completely via the terminal. It takes its inspiration from the [ROOT object browser](https://root.cern/doc/master/classTRootBrowser.html).\n\n## Installation\n\nYou can install this library from [PyPI](https://pypi.org/project/uproot-browser/) with `pip`:\n\n```bash\npython3 -m pip install uproot-browser\n```\n\nYou can also use `pipx` to run the library without installing it:\n\n```bash\npipx run uproot-browser\n```\n\n## Features\n\nuproot-browser currently provides the following features (get help with `-h` or `--help`, view the current version with `--version`):\n\n- `browse` can be used to display a TUI (text user interface), acts as default if no subcommand specified.\n- `plot` can be used to display a plot.\n- `tree` can be used to display a tree.\n\n\n## Examples\n\nThis example uses data from the [scikit-hep-testdata](https://github.com/scikit-hep/scikit-hep-testdata) package. It is placed in the same directory as the uproot-browser repository.\n\n**`browse` command:**\n\n```bash\nuproot-browser browse ../scikit-hep-testdata/src/skhep_testdata/data/uproot-Event.root\n```\n\n![GIF of the TUI functionality](https://github.com/scikit-hep/uproot-browser/releases/download/v0.5.0/tui.gif)\n\n**`plot` command:**\n\n```bash\nuproot-browser plot ../scikit-hep-testdata/src/skhep_testdata/data/uproot-Event.root:hstat\n                        hstat -- Entries: 1000\n    ┌───────────────────────────────────────────────────────────────┐\n18.0┤▐▌                                                             │\n    │▐▌                                                 ▗▖         ▄│\n15.6┤▐▌▗▖                                               ▐▌         █│\n    │███▌               █                           █   ▐▌        ▐█│\n13.1┤████▟▌    ▗▖  ▗▖   █▌▗▖ ▐▌       ▄   █▌   ▄  ▟▌█ ▗▄▐▙▗▖    ▐▌▐█│\n10.6┤█████▌    ▐▌  ▐▙▖  █▌▐▌ ▐▙       █▄  █▙   █  █▌█ ▐█▟█▐▌  ▗▄▟▌▐█│\n    │█████▌ █▌▐█▌  ████▌█▌▐█ ▐█▐▌ ▐▌  ███▐██  ▐█ ▐████▐███▐▌ ▐███▌▐█│\n 8.2┤█████▌▐█▌▐█▌ █████▌██▐█ ██▐█ ▐▌▐████▐███▌▐█ █████▐███▐██▐████▐█│\n    │████████▙██▌█████████▟█▖████▖▟██████▟██████▖████████████▟██████│\n 5.8┤███████████▙███████████▙████▌██████████████▌███████████████████│\n    │████████████████████████████▌██████████████████████████████████│\n 3.3┤███████████████████████████████████████████████████████████████│\n    └┬───────────────┬──────────────┬───────────────┬──────────────┬┘\n     0.00          0.25           0.50            0.75          1.00\n                               [x] xaxis\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eIf you're on macOS and using iTerm2, click here:\u003c/summary\u003e\u003cbr\u003e\n\nYou can get an iterm plot, the required dependencies can be installed via:\n\n```bash\npython3 -m pip install uproot-browser[iterm]\n```\n\nOr can be run via `pipx` without installing:\n\n```bash\npipx run uproot-browser[iterm]\n```\n\nAdding the argument `--iterm` gives us the plot:\n\n```bash\nuproot-browser plot ../scikit-hep-testdata/src/skhep_testdata/data/uproot-Event.root:hstat --iterm\n```\n\n\u003cimg alt=\"iterm example\" width=\"600px\" src=\"https://raw.githubusercontent.com/scikit-hep/uproot-browser/main/docs/_images/iterm.png\"/\u003e\n\n\u003c/details\u003e\u003cbr\u003e\n\n**`tree` command:**\n\n```bash\nuproot-browser tree ../scikit-hep-testdata/src/skhep_testdata/data/uproot-Event.root\n📁 uproot-Event.root\n┣━━ ❓ \u003cunnamed\u003e TProcessID\n┣━━ 🌴 T (1000)\n┃   ┗━━ 🌿 event Event\n┃       ┣━━ 🌿 TObject (group of fUniqueID:uint32_t, fBits:uint32_t)\n┃       ┃   ┣━━ 🍁 fBits uint32_t\n┃       ┃   ┗━━ 🍁 fUniqueID uint32_t\n┃       ┣━━ 🍁 fClosestDistance unknown[]\n┃       ┣━━ 🍁 fEventName char*\n┃       ┣━━ 🌿 fEvtHdr EventHeader\n┃       ┃   ┣━━ 🍁 fEvtHdr.fDate int32_t\n┃       ┃   ┣━━ 🍁 fEvtHdr.fEvtNum int32_t\n┃       ┃   ┗━━ 🍁 fEvtHdr.fRun int32_t\n┃       ┣━━ 🍁 fFlag uint32_t\n┃       ┣━━ 🍁 fH TH1F\n┃       ┣━━ 🍁 fHighPt TRefArray*\n┃       ┣━━ 🍁 fIsValid bool\n┃       ┣━━ 🍁 fLastTrack TRef\n┃       ┣━━ 🍁 fMatrix[4][4] float[4][4]\n┃       ┣━━ 🍁 fMeasures[10] int32_t[10]\n┃       ┣━━ 🍁 fMuons TRefArray*\n┃       ┣━━ 🍁 fNseg int32_t\n┃       ┣━━ 🍁 fNtrack int32_t\n┃       ┣━━ 🍁 fNvertex uint32_t\n┃       ┣━━ 🍁 fTemperature float\n┃       ┣━━ 🌿 fTracks TClonesArray*\n┃       ┃   ┣━━ 🍃 fTracks.fBits uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fBx Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fBy Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fCharge Double32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fMass2 Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fMeanCharge float[]\n┃       ┃   ┣━━ 🍃 fTracks.fNpoint int32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fNsp uint32_t[]\n┃       ┃   ┣━━ 🍁 fTracks.fPointValue unknown[][]\n┃       ┃   ┣━━ 🍃 fTracks.fPx float[]\n┃       ┃   ┣━━ 🍃 fTracks.fPy float[]\n┃       ┃   ┣━━ 🍃 fTracks.fPz float[]\n┃       ┃   ┣━━ 🍃 fTracks.fRandom float[]\n┃       ┃   ┣━━ 🍃 fTracks.fTArray[3] float[][3]\n┃       ┃   ┣━━ 🍁 fTracks.fTriggerBits.fAllBits uint8_t[][]\n┃       ┃   ┣━━ 🍃 fTracks.fTriggerBits.fBits uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fTriggerBits.fNbits uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fTriggerBits.fNbytes uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fTriggerBits.fUniqueID uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fUniqueID uint32_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fValid int16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fVertex[3] Double32_t[][3]\n┃       ┃   ┣━━ 🍃 fTracks.fXfirst Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fXlast Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fYfirst Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fYlast Float16_t[]\n┃       ┃   ┣━━ 🍃 fTracks.fZfirst Float16_t[]\n┃       ┃   ┗━━ 🍃 fTracks.fZlast Float16_t[]\n┃       ┣━━ 🌿 fTriggerBits TBits\n┃       ┃   ┣━━ 🌿 fTriggerBits.TObject (group of fTriggerBits.fUniqueID:uint32_t, fTriggerBits.fBits:uint32_t)\n┃       ┃   ┃   ┣━━ 🍁 fTriggerBits.fBits uint32_t\n┃       ┃   ┃   ┗━━ 🍁 fTriggerBits.fUniqueID uint32_t\n┃       ┃   ┣━━ 🍃 fTriggerBits.fAllBits uint8_t[]\n┃       ┃   ┣━━ 🍁 fTriggerBits.fNbits uint32_t\n┃       ┃   ┗━━ 🍁 fTriggerBits.fNbytes uint32_t\n┃       ┣━━ 🍁 fType[20] int8_t[20]\n┃       ┗━━ 🍁 fWebHistogram TRef\n┣━━ 📊 hstat TH1F (100)\n┗━━ 📊 htime TH1F (10)\n```\n\n## Development\n\n[![pre-commit.ci status][pre-commit-badge]][pre-commit-link]\n\nSee [CONTRIBUTING.md](https://github.com/scikit-hep/uproot-browser/blob/main/.github/CONTRIBUTING.md) for details on how to set up a development environment.\n\n[actions-badge]:            https://github.com/scikit-hep/uproot-browser/workflows/CI/badge.svg\n[actions-link]:             https://github.com/scikit-hep/uproot-browser/actions\n[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/uproot-browser\n[conda-link]:               https://github.com/conda-forge/uproot-browser-feedstock\n[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions\u0026message=Ask\u0026color=blue\u0026logo=github\n[github-discussions-link]:  https://github.com/scikit-hep/uproot-browser/discussions\n[gitter-badge]:             https://badges.gitter.im/Scikit-HEP/community.svg\n[gitter-link]:              https://gitter.im/Scikit-HEP/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\n[license-badge]:            https://img.shields.io/badge/License-BSD_3--Clause-blue.svg\n[license-link]:             https://opensource.org/licenses/BSD-3-Clause\n[pypi-link]:                https://pypi.org/project/uproot-browser/\n[pypi-platforms]:           https://img.shields.io/pypi/pyversions/uproot-browser\n[pypi-version]:             https://badge.fury.io/py/uproot-browser.svg\n[sk-badge]:                 https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg\n[pre-commit-badge]:         https://results.pre-commit.ci/badge/github/scikit-hep/uproot-browser/main.svg\n[pre-commit-link]:          https://results.pre-commit.ci/repo/github/scikit-hep/uproot-browser\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscikit-hep%2Fuproot-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscikit-hep%2Fuproot-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscikit-hep%2Fuproot-browser/lists"}