Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc update: Returned data sections #380

Open
dshean opened this issue Feb 23, 2024 · 0 comments
Open

Doc update: Returned data sections #380

dshean opened this issue Feb 23, 2024 · 0 comments
Labels
documentation User guide, api reference, tutorials

Comments

@dshean
Copy link
Member

dshean commented Feb 23, 2024

https://slideruleearth.io/web/rtd/user_guide/ICESat-2.html#returned-data

These should be updated to match the current v4 structure of the returned GeoDataFrame objects. We index on time, which is converted to a Pandas Timestamp object. The geometry column stores (longitude, latitude), and these fields are removed. Order of fields listed in doc should be consistent with the actual order.

Should add ancillary fields to the returned data section.

Should also be clear in this sesction that data can be returned different formats, as doc right now mostly focuses on GeoDataFrames. Esp if we start supporting additional output formats like COPC.

@dshean dshean added the documentation User guide, api reference, tutorials label Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User guide, api reference, tutorials
Projects
None yet
Development

No branches or pull requests

1 participant