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

ALE Driver Architecture #48

Merged
merged 10 commits into from
May 6, 2024
Merged

Conversation

jrcain-usgs
Copy link
Contributor

@jrcain-usgs jrcain-usgs commented Apr 25, 2024

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.

Addresses the conceptual points in #32

@jrcain-usgs jrcain-usgs self-assigned this Apr 25, 2024

## Ale::load

- ? Not sure exactly what is intended for this section ?
Copy link
Collaborator

Choose a reason for hiding this comment

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

This needs to cover how loads works. That is, how it iterates over each driver and attempts to build an ISD with each. How loads quick rejects ISDs (using instrument IDs, look at the code and instructions for how to make an ale driver for examples). And how this can sometimes cause issues (sometimes a driver can succeed before the driver you want).

Also mention isd_generate as an app that can do most of the boilerplate for you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sometimes a driver can succeed before the driver you want

I mentioned this in my current draft, but I don't think I've seen this issue myself. Would different instrument_ids prevent this from happening? What can someone do if that happens to them?

docs/concepts/ale/ale-driver-development-concepts.md Outdated Show resolved Hide resolved
docs/concepts/ale/ale-driver-development-concepts.md Outdated Show resolved Hide resolved
@jrcain-usgs jrcain-usgs marked this pull request as ready for review May 1, 2024 16:49
@jrcain-usgs jrcain-usgs changed the title Outline for ALE dev concepts ALE Driver Architecture May 1, 2024
Copy link
Contributor

@acpaquette acpaquette left a comment

Choose a reason for hiding this comment

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

Overall good encapsulation of the ALE architecture, couple things to address when talking about ISIS cameras

docs/concepts/ale/ale-driver-architecture.md Outdated Show resolved Hide resolved
docs/concepts/ale/ale-driver-architecture.md Outdated Show resolved Hide resolved
docs/concepts/ale/ale-driver-architecture.md Outdated Show resolved Hide resolved
@jrcain-usgs jrcain-usgs requested a review from acpaquette May 1, 2024 20:49
@Kelvinrr
Copy link
Collaborator

Kelvinrr commented May 3, 2024

My concerns have been addressed, if @acpaquette also gives a +1 then this is good to merge.

@jrcain-usgs jrcain-usgs merged commit 46e5bf0 into DOI-USGS:main May 6, 2024
3 checks passed
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