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 shadow documentation to mention when SPICE kernels are needed #4335

Merged
merged 2 commits into from
Mar 5, 2021

Conversation

krlberry
Copy link
Contributor

@krlberry krlberry commented Mar 4, 2021

Description

shadow already supported getting sun position from a spiceinited cube, so this is just a documentation update to explain in what circumstances local kernels are required.

Related Issue

#4303

Motivation and Context

See #4303 .

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation change (update to the documentation; no code change)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have read and agree to abide by the Code of Conduct
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have added myself to the .zenodo.json document.
  • I have added any user impacting changes to the CHANGELOG.md document.

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

@krlberry krlberry requested review from Kelvinrr and scsides March 4, 2021 15:43
Kelvinrr
Kelvinrr previously approved these changes Mar 4, 2021
Copy link
Collaborator

@Kelvinrr Kelvinrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, I'd feel better if @scsides +1s before merging though.

@@ -20,7 +20,8 @@

<strong>User-Requirements</strong><br/>
The user must supply an elevation model (DEM) and either an observation time or a cube
with raw camera geometry (see 'spiceinit').<br/><br/>
with raw camera geometry (see 'spiceinit'). If providing an observation time, the SPICE kernels
associated with the image target must have been downloaded and be available on the user's machine.<br/><br/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you just saw the code, it would be nice to specify which kernels if it can be boiled down. I don't mean file names, more like file types, and might want to use $ISISDATA in the description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants