search

dendrograms / astrodendro

Generate a dendrogram from a dataset
https://dendrograms.readthedocs.io/
Other
37 stars 38 forks source link

More user-friendly way to figure out what metadata is needed where #59

Closed ChrisBeaumont closed 11 years ago

ChrisBeaumont commented 11 years ago

There should be some nice way to lookup what statistic properties require what metadata items -- maybe this should be embedded into the docstring

astrofrog commented 11 years ago

One issue is that the meta-data depends on e.g. the flux units - so beam size is only require when converting from Jy/beam, etc. However, I agree that we should basically document the different options. The docstring of the properties may not be a good place because only the first sentence of the docstring is shown in the API docs. How about simply adding a section to the catalog.rst file describing what is required for which statistics and depending on units?

ChrisBeaumont commented 11 years ago

Adding the information to catalog.rst is probably a fair compromise

astrofrog commented 11 years ago

Ok, I can work on this over the weekend!

astrofrog commented 11 years ago

Done in #67