Review documentation - Githubissues

icecube / FIRESONG

FIRst Extragalactic Simulation Of Neutrino and Gamma-ray

Other

18 stars 8 forks source link

Review documentation #16

Closed apizzuto closed 3 years ago

apizzuto commented 3 years ago

"I [Ignacio] will take care of this over the next few months actually, and we can steal material from Chris’ PhD thesis"

itaboada commented 3 years ago

To do:

Update documentation for FIRESONG.py.
Write documentation for Legend.py

itaboada commented 3 years ago

Alex has added API documentation. Also needed is an expanded and reviewed README.md In the README.md we need: description of dependencies (cosmolopy, numpy, scipy, python3); installation instructions; description of command line options; description of units; description of output; example usage of Firesong.py, Legend.py and FluxPDF.py.

itaboada commented 3 years ago

All done!