DOI-USGS / DOI-USGS/asc-public-docs

How-to: make a ALE driver

Open
#32 0 comments 0 reactions 1 assignee Claimed by @jrcain-usgs View on GitHub
Dominant language
HTML
Stars
1
Forks
12
Avg merge
4d 6h
Merged PRs (30d)
2

Description

How-to that should explain the process for creating an ALE driver from no code to ISD.

Not exhaustive list of things the user should know:

- [x] Why are the drivers necessary?
- [x] What are mixins and how does ALE use them?
- [x] How do I determine what should be overwritten?
- [x] What does `Ale::load` do and why is it important during driver creation?
- [ ] What should I do if the mixin I need doesn't exist?
- [ ] direct to a separate how-to guide on mixins
- [ ] How can I test my new driver?

I imagine it would pretty long so splitting some of these to different guides might make sense.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.