21cmfast / 21cmFAST

Official repository for 21cmFAST: a code for generating fast simulations of the cosmological 21cm signal
MIT License
58 stars 37 forks source link

[Feature Req.] Option for CLI to output basic plots #257

Open steven-murray opened 2 years ago

steven-murray commented 2 years ago

Is your feature request related to a problem? Please describe.

Running the CLI produces a lightcone/coeval dataset, but no plots or anything tangible to look at. This can be a bit disconcerting, since by default the outputs are in the cache, which is kinda hidden, which means it might seem like the call did nothing at all. Outputting at least a lightcone/coeval default plot (and maybe xHI/global signal if appropriate) would at least assure the user that things ran OK, and give them a way to check what their options look like.

Describe the solution you'd like

Just a new --plot option, potentially with string options that it can take, specifying different plots to make.

Describe alternatives you've considered

An alternative would be to have another CLI command 21cmfast plot which can be pointed at a particular lightcone in the cache. At the end of the 21cmfast lightcone command output, it could say something like "Use 21cmfast plot <file> to get plots!"