search

SWIFTSIM / emulator

The SWIFT simulation cosmological emulator (swift-emulator)
GNU Lesser General Public License v3.0
5 stars 2 forks source link

[JOSS review] Minor fixes in docs #38

Closed kstoreyf closed 2 years ago

kstoreyf commented 2 years ago

Part of JOSS review.

The examples are generally very clean and detailed, nicely done! I have a few small things I noticed while I was going through them:

  1. For the velociraptor comparison, it is not clear how to get the data that is used in the example code on that page. The page links to the velociraptor-comparison-data repo, but it would be nice to give the steps for downloading the Vernon.hdf5 file needed into the right place (requires cloning the repo and running a conversion script, which I figured out after a bit but wasn't obvious). Alternatively, you could provide a direct link to download that file.
  2. ReadTheDocs isn't properly pulling in the data for the visualization module.
  3. It would be nice to add axis labels (and legends where applicable) to the plots in the examples, so they can be understood without having to read the plotting code, e.g. on the Getting Started page, the Sweep analysis tool, and the penalty plots.
Moyoxkit commented 2 years ago

Thanks! and thanks for the comments as well. I'm adding your third point here: #40

For point 1 and 2, @JBorrow Could you look into these? I think it would indeed be a good idea to just be able to directly copy Vernon.hdf5 from somewhere.

JBorrow commented 2 years ago

The issues 1 & 2 are now fixed in the main branch. Thanks!