konkolyseismolab / seismolab

Open-source python framework for downloading, analyzing, and visualizing data of variable stars from space-based surveys.
https://seismolab.readthedocs.io/en/latest/index.html
MIT License
3 stars 1 forks source link

documentation: statement of need #3

Closed darthoctopus closed 1 month ago

darthoctopus commented 2 months ago

First, I'd like to say that the documentation you've put together is extremely impressive, from a technical perspective! Only one issue remains per the JOSS checklist:

A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?

I do not believe this is explicitly addressed yet. Perhaps this can go in the "About seismolab" page, which is pretty empty at the moment except for funding information?

ref: https://github.com/openjournals/joss-reviews/issues/7118#issuecomment-2302742402

astrobatty commented 1 month ago

First, I'd like to say that the documentation you've put together is extremely impressive, from a technical perspective!

Thanks @darthoctopus !

I updated the documentation accordingly.

darthoctopus commented 1 month ago

Looks good to me, thanks!