diff --git a/README.md b/README.md index 6557a11ed17d880afb9d68fe96888cde4bd09ebe..c1a8c25d68c8e517c0a95acba60ce0e6a2f339bd 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ This allows `KM3io.jl` to be completely free from these external dependencies. The library is still under development so that the API might slightly change. Feedback and contributions are highly welcome! +# Documentation + +Check out the **[Latest Documention](https://common.pages.km3net.de/KM3io.jl/dev)** +which also includes tutorials and examples. + # Installation `KM3io.jl` is not an officially registered Julia package but it's available via @@ -53,17 +58,4 @@ OfflineTree (10 events) julia> some_event = f.offline[3] KM3io.Evt (3680 hits, 28 MC hits, 38 tracks, 12 MC tracks) -# TODOs - -These are mostly low-hanging fruits, so feel free to contribute! `;)` - -- [ ] Best track selection (cf. the implementation in [km3io](https://git.km3net.de/km3py/km3io/-/blob/b71300ff1364394d01323a732585f0a8dae303b1/src/km3io/tools.py#L203) or [KM3NeT Dataformat](https://git.km3net.de/common/km3net-dataformat/-/blob/881972133aa0fda809d06c97d9736d346dd35efb/tools/reconstruction.hh#L374), latter being much more closer to the Julia implementation since we don't need all the fancy masking/slicing magic as in Python) -- [ ] Hit calibration for the offline format: fairly straight forward -- [ ] Event+Summaryslice matching: for a given event, return the correct summaryslice to be able to query the most recent PMT rates -- [ ] Optimise type hierarchy -- [ ] Examples! - - -# Acknowledgements - -Thanks for Johannes Schumann for providing the awesome project logo! +```