search

lbl-anp / becquerel

Becquerel is a Python package for analyzing nuclear spectroscopic measurements.
Other
43 stars 16 forks source link

[documentation] Please add more usage examples in the README #399

Open eabase opened 7 months ago

eabase commented 7 months ago

There are absolutely Zero installation and usage instruction here. Nor any links to relevant pages where this package is used. :(

Can you please add some usage examples, including screenshots to the README?

jvavrek commented 7 months ago

Hi @eabase, thanks for the feedback.

We have the installation instructions right at the top of the README:

image

We also have a pretty extensive set of usage examples in the top-level examples/ directory:

image

but we agree we should add some examples to the README directly.

Unfortunately we don't have a good idea of where other people use becquerel. It's an open-source library for spectral data analysis but those analysis projects themselves tend not to be open-source.

eabase commented 7 months ago

@jvavrek Thanks for response. Well, you're talking about a spectral analysis program with GUI, so the one thing you'd expect is a few screenshots of exactly that.

jvavrek commented 7 months ago

Hi @eabase,

becquerel is not a program in and of itself, but a library for others to build their own analysis programs. In this case, "the one thing you'd expect" would be example code, which as mentioned can be found in the top-level examples/ directory.

Moreover, becquerel deliberately provides no GUI—this was a design choice made early on in order to focus on just the backend library code. If you need a GUI, you may find https://github.com/mauricioAyllon/NASA-gamma useful.

If you can point to any concrete instances where we refer to a GUI or some kind of standalone program, please show us, and we'll be happy to change them.