villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Feature/paper changes #18

Closed nuclearGoblin closed 2 years ago

nuclearGoblin commented 3 years ago

Attempt to address #11 - various issues with the paper writing, mostly with paper containing documentation.

Most noticeably I removed the figure outlining the outputs; I also removed the equations outlining some of the program's calculations and tried to reduce the verbosity of the explanation of the remaining figure. Any information that was removed from the paper should now be in the README (with the exception of explaining in too much detail the code in the example-usecase directory's notebook, as it is meant to explain the code as it goes along).

Things to check for: In general, elaboration could possibly use some more work, but I was stuck on what to elaborate on. Similarly, there may be some documentation-type things remaining.