Documentation - Githubissues

SWIFTSIM / emulator

The SWIFT simulation cosmological emulator (swift-emulator)

GNU Lesser General Public License v3.0

5 stars 2 forks source link

Documentation #20

Closed Moyoxkit closed 2 years ago

Moyoxkit commented 3 years ago

Small list of thing we should add to the documentation.

Basic example (DONE)
Installation guide (DONE)
Performance options (Think cross-checks and other neat things) (DONE)
GP options (mean models etc) (DONE)
io with SWIFT (DONE)
Penalty functions/compare with data things (DONE)

I can work on the performance/GP options and penalty functions, might need some help for the io and installation.

JDonaldM commented 2 years ago

Just tagging the JOSS review thread here as although the installation instructions are in the README it would be good to have them on the docs just incase someone lands on read the docs before the repo.

Moyoxkit commented 2 years ago

Thanks for the comment! This should now be added to the getting started section of the docs (https://github.com/SWIFTSIM/emulator/pull/31)