21cmfast / 21cmFAST

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

change default behaviour of from_file and read methods #431

Closed daviesje closed 1 month ago

daviesje commented 2 months ago

File loading keywords were confusing and the docstrings were incorrect.

I've changed the default reading behaviour to not load any arrays, and the keyword arrays_to_load or keys for from_file or read respectively works as follows:

Passing empty array []: load nothing Passing None: load everything Passing a list of array names: load that subset of arrays

This is technically API breaking so I'm placing this PR in v4-prep