search

NASA-Planetary-Science / sbpy

A Python package for small bodies research
https://sbpy.org/
Other
66 stars 34 forks source link

Standardize the dimension specification in Field Name List and improve tests #221

Open jianyangli opened 4 years ago

jianyangli commented 4 years ago

This is a request for

The requested changes will be implemented by

High-level concept [Provide a short description of the scientific or technical problem that your new feature would address.]

As suggested by @mkelley in PR #218:

  1. The dimension in the column in Field Name List should be standardized to be directly recognizable by astropy.units.
  2. Add tests to check dimensions of all fields in sbpy.data.

Explain the relevance to sbpy [Why is this relevant to sbpy but not to any other astropy affiliated or other package?]

Simplify dimension check in all sbpy code that uses DataClass.

Proposal details [Provide details technical and scientific details on your request. Is there a publication that uses the same method as requested here? If you plan to implement this feature yourself: How will you implement the code? ]

The standardized dimension string should be either valid 'physical type' as defined in astropy.units, or a base unit that can be converted to a valid astropy unit by a astropy.unit.Unit() call. Exceptions can exist, such as when the field is a astropy.time.Time instance. Standard logarithmic unit and astropy.units.MagUnit are also exceptions due their flexible physical bases.

Example (pseudo-)code [Only required if you plan to implement this feature yourself: Provide a short example demonstrating the expected API]

mkelley commented 2 years ago

I think I've mostly addressed this with #275. However, I was not aware of astropy's PhysicalTime and locally implemented a similar solution. So, I would prefer using astropy machinery over our own, so I would like to do that. Thanks for pointing this out.