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

The reason that sunkit-image exists #200

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

The reason that sunkit-image exists #200

wants to merge 3 commits into from

Conversation

nabobalis
Copy link
Contributor

@nabobalis nabobalis commented Apr 10, 2024

Fixes #190

@nabobalis nabobalis changed the title add mission statement The reason that sunkit-image exists Apr 10, 2024
@nabobalis nabobalis marked this pull request as ready for review April 10, 2024 21:10
The goal of the ``sunkit-image`` library is to provide access to image processing routines that are:

1. Focused on being applied to solar physics data.
2. Are published in the literature.
Copy link
Member

Choose a reason for hiding this comment

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

What about that are in-prep? I like the idea of people writing their algorithms in sunkit-image before they publish so they can say that's where it will be in the paper? Or does this open us up to "oh we are going to publish this eventually"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about if they can prove its in prep?


1. Focused on being applied to solar physics data.
2. Are published in the literature.
3. If there is no publication, it must be widely used or perceived as generally useful throughout the solar physics community.
Copy link
Member

Choose a reason for hiding this comment

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

I see the reason for this but it's a bit wolly? 🐑

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes this is very wolly, deliberately so.

Mind, I did not have a specific use case in mind when I wrote this but I did want an out but that does leave us open to a "debate" about a code.

The goal of the ``sunkit-image`` library is to provide access to image processing routines that are:

1. Focused on being applied to solar physics data.
2. Are published in the literature.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
2. Are published in the literature.
2. Are published in the literature or in preparation to be published.

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

Successfully merging this pull request may close these issues.

Add a section to the docs about which algorithms we accept
3 participants