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

Update doc strings #453

Open
9 tasks done
jlaura opened this issue Aug 31, 2023 · 3 comments · May be fixed by #476
Open
9 tasks done

Update doc strings #453

jlaura opened this issue Aug 31, 2023 · 3 comments · May be fixed by #476
Assignees
Labels
documentation issue with broken links, typos, grammar, unclear descriptions, etc. found in the documentation

Comments

@jlaura
Copy link
Collaborator

jlaura commented Aug 31, 2023

The autogenerated sphinx docs are terrific! There is work to be done now ensuring that all methods are documented and that the docs are cleaned. Example of that cleaning include removing instructions to research something and ??? instances for parameters, among others.

Library Reference

  • USGSCSM Distortion Class
  • USGSCSM Utilities Class
  • USGSCSM Astro Plugin Class
  • USGSCSM Astro Frame Sensor Model Class
  • USGSCSM Linescan Sensor Model Class
  • USGSCSM SAR Sensor Model Class

Cameras

It appears that only a subset of the cameras that can be used with USGSCSM are rendering examples. This issue completed would be an up to date example of instantiating a sensor model for each (longer term, I anticipate moving this to one or more pages in a /examples/<> section of the documentation.

  • All camera examples updated and rendering

Creating an environment

These look like installation instructions. If so, we should move these first and fix the rendering.

  • Install instructions shifted to the top and updated to fix all rendering.
  • If installation with pip is supported add that.

Creating and testing an ISD

I think we probably should remove the ale how to and link to those docs once released. Then we can assume one has an ISD already and go from there. A great first tutorial (FY24) would be getting the USGSCSM stack installed, creating an ISD, and then computing something (footprint, photometric angles on a DEM, etc.)

@antonhibl antonhibl self-assigned this Feb 7, 2024
@antonhibl antonhibl added the documentation issue with broken links, typos, grammar, unclear descriptions, etc. found in the documentation label Feb 7, 2024
@antonhibl antonhibl linked a pull request Feb 14, 2024 that will close this issue
11 tasks
@antonhibl antonhibl linked a pull request Feb 14, 2024 that will close this issue
11 tasks
@antonhibl
Copy link
Contributor

@jlaura I am working on the updating of camera rendering examples and wondering if there is somewhere I can find examples of the rendering(s) for each camera model available through CSM to use or if I will need to develop some examples for these docs?

@Kelvinrr
Copy link
Collaborator

It seems @jlaura is talking about creating copy-pasta style examples for instantiating a camera model for more instruments? Similar to https://usgscsm.readthedocs.io/en/latest/sensors/Cassini.html. If so, I think that belongs more in the asc-public-docs since that is a combination of ALE and USGSCSM code in the examples.

@jlaura
Copy link
Collaborator Author

jlaura commented Apr 12, 2024

Yup, these might be two examples. Create an ALE ISD and create and ALE state. Then these should 'just' work for all supported sensors, right? The docs could link to ALE documentation that shows which sensors are supported.

Like @Kelvinrr said, these should be in the ASC docs. Not sure why I included that here. Maybe this predated those docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issue with broken links, typos, grammar, unclear descriptions, etc. found in the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants