search

JuliaHEP / AwkwardArray.jl

Awkward Array in Julia mirrors the Python library, enabling effortless zero-copy data exchange between Julia and Python
https://juliahep.github.io/AwkwardArray.jl/dev/
MIT License
31 stars 2 forks source link

docs: add `getting started` guide #98

Closed ianna closed 4 months ago

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 75.27%. Comparing base (5b18d99) to head (7ce2fd4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #98 +/- ## ======================================= Coverage 75.27% 75.27% ======================================= Files 4 4 Lines 1630 1630 ======================================= Hits 1227 1227 Misses 403 403 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jpivarski commented 4 months ago

It looks great! This can definitely get new users started. If they're familiar with Awkward Array from Python, they might get to the end of the documentation and still be looking for the ak.* equivalents, not realizing that the way they ought to be used in Julia is different: compiled for loops are not something to be avoided. This could, perhaps, be clarified with usage examples, such as a Z peak, with lots of for loops. But a more important first step would be to get physicist users involved. First adopters would figure out what the best practices are, and maybe also find design issues that need to be fixed.

Moelf commented 4 months ago

At some point we probably want to make the documentation entries less redundant, I will see what I can do