search

ejhigson / dyPolyChord

Super fast dynamic nested sampling with PolyChord (Python, C++ and Fortran likelihoods).
http://dypolychord.readthedocs.io/en/latest/
MIT License
22 stars 5 forks source link

Documentation - statement of need #1

Closed andrewfowlie closed 6 years ago

andrewfowlie commented 6 years ago

Hi there,

For my review,

Documentation

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

I couldn't see this information clearly in the docs. It was clear in the software paper, though.

ejhigson commented 6 years ago

Again thanks for pointing this out! I have added this bit of the paper to the software documentation at https://dypolychord.readthedocs.io/en/latest/.

If you are happy with this I will close the issue.

andrewfowlie commented 6 years ago

I think the docs are still missing

who the target audience is?

and it could be much clearer about what it calculates, i.e. the Bayesian evidence. I think both should be in the first few (if not the first) paragraph of the docs.

ejhigson commented 6 years ago

This is a good point - now looking at it again you are definitely right. I have added a sentence saying what nested sampling calculates as the first sentence of the homepage here https://dypolychord.readthedocs.io/en/latest/.

I am going to provisionally close this issue but let me know if you think it should be reopened!

ejhigson commented 6 years ago

I should add: I think it is implicit that the target audience is "people who want to calculate Bayesian evidences and/or posterior samples from a likelihood and prior", but let me know if you think this should be further clarified.