search

rice-solar-physics / pydrad

Python tools for setting up HYDRAD runs and parsing output
https://pydrad.readthedocs.io
MIT License
4 stars 3 forks source link

Make sample config dict more visible #138

Closed jwreep closed 2 years ago

jwreep commented 3 years ago

It would be extremely useful to have a sample configuration dict bundled in the repository, perhaps with recommended defaults. It's a bit tedious to set one up from scratch.

wtbarnes commented 3 years ago

Check https://github.com/rice-solar-physics/pydrad/blob/master/defaults.asdf. You can then load it like so: https://pydrad.readthedocs.io/en/latest/configure.html#setting-a-default-configuration. Note that you can also save out your own config and read it back in at any time: https://pydrad.readthedocs.io/en/latest/api/pydrad.configure.Configure.html#pydrad.configure.Configure.save_config

jwreep commented 3 years ago

Ah, thanks. I missed this.

wtbarnes commented 3 years ago

Though I think it is fair to say we should make this more visible and maybe easier to access from the package.

jwreep commented 3 years ago

Is there a function to print out the whole thing? What I'm imagining is just quickly configuring a jupyter notebook, which can be done quickest if one can see all of the possible entries at once. For example, just copying and pasting a complete dictionary to the top of this page: https://rice-solar-physics.github.io/pydrad/configure/