search

ChristopherMayes / openPMD-beamphysics

Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
https://christophermayes.github.io/openPMD-beamphysics/
Apache License 2.0
16 stars 15 forks source link

add example data #36

Closed bwheelz36 closed 1 year ago

bwheelz36 commented 1 year ago

Could I also suggest for the docs, pointing to an example dataset that people could quickly download and play with - maybe this one?

ChristopherMayes commented 1 year ago

All of the data associated with the docs are within this repository: https://github.com/ChristopherMayes/openPMD-beamphysics/tree/master/docs/examples/data. Do you still suggest something separate?

bwheelz36 commented 1 year ago

no, that seems good - it's more that it wasn't clear to me looking through the docs where this data is? Perhaps I missed this statement though?

ChristopherMayes commented 1 year ago

The docs notebooks work when cloning this entire repository. I could think of a different way.

bwheelz36 commented 1 year ago

in my case, I pip installed the package and then wanted to play with the data. Now I look more closely I should have been able to figure out where it was! Anyway I would just suggest a note at the top of the examples "The data used in these examples can be downloaded [here]()" but totally up to you :-)