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

Higher-level interface? #339

Closed
ajwheeler opened this issue Oct 5, 2024 · 0 comments · Fixed by #348
Closed

Higher-level interface? #339

ajwheeler opened this issue Oct 5, 2024 · 0 comments · Fixed by #348
Milestone

Comments

@ajwheeler
Copy link
Owner

ajwheeler commented Oct 5, 2024

In designing Korg's top-level API, I've taken some care to break things apart where appropriate. For example, I think it's "correct" that interpolate_marcs, format_A_X, apply_LSF etc, are separate functions.

However, as things get more complex, I'm taking more seriously the idea of having a simple top level function (Korg.spectrum?) that requires even less documentation-reading (initial credit to Alex Ji for this idea, I think).

Ideally, this would have no positional arguments except wavelength specifiers, that means that there would have to be a default linelist. This is the biggest hurdle, and may be the thing that prevents me from doing it.

Any ideas about how to simplify Korg's interface for the median use case are welcome.

@ajwheeler ajwheeler added this to the 1.0 milestone Oct 5, 2024
@ajwheeler ajwheeler mentioned this issue Oct 17, 2024
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 a pull request may close this issue.

1 participant