scikit-hep / scikit-hep/vector

Rewrite vector design prototype notebook using modern uproot and awkward

Open
#273 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs help wanted
Dominant language
Python
Stars
99
Forks
42
Avg merge
1d 13h
Merged PRs (30d)
6

Description

Eventually maybe we can re-add it, it's a great resource for how to write a numba extension (well, it was). Fine to take it out for now.

Originally posted by @henryiii in https://github.com/scikit-hep/vector/pull/272#discussion_r997444552

The vector_design_prototype.ipynb was removed in PR #272, but it should be rewritten as it is a useful resource.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the removed docs/usage/vector_design_prototype.ipynb and PR #272, then compare the original notebook's purpose with current vector documentation. Rewrite the notebook using modern uproot and awkward, and consider the work complete when it is restored as a useful, runnable resource.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.