-
Notifications
You must be signed in to change notification settings - Fork 27
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
Feat: add text associated with astropy partnership #225
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# pyOpenSci's partnership with Astropy | ||
|
||
:::{image} /images/astropy_project_logo.svg | ||
:alt: The Astropy logo. The logo is an orange egg shape with a white snake spiraling in it. The text of the image says The Astropy Project on three lines. | ||
:width: 600px | ||
:align: center | ||
::: | ||
|
||
pyOpenSci has a collaboration with the [Astropy scientific community](https://www.astropy.org/). Through this collaboration we add an additional layer of peer review checks to Astropy-related packages that go through our [open peer review process](https://www.pyopensci.org/software-peer-review/about/intro.html). If the package meets both the [Astropy criteria for becoming an affiliated package](https://www.astropy.org/affiliated/#becoming-an-affiliated-package) and our pyOpenSci peer review criteria, it can then become both an Astropy-affiliated package and a pyOpenSci ecosystem package. | ||
|
||
If you are submitting a package for review and wish to also apply for Astropy affiliation, your package will be: | ||
|
||
* Reviewed against current pyOpenSci guidelines and checks. | ||
* Also reviewed against the Astropy-specific guidelines listed below. | ||
|
||
(astropy-collaboration)= | ||
### Astropy Specific Software Peer Review Guidelines | ||
|
||
To be an affiliated Astropy package, your package should: | ||
|
||
- Be useful to astronomers. This can mean useful to a specific sub-domain of astronomy, or more broadly useful to a large fraction of astronomy (or beyond, as long as it is also useful for astronomy). | ||
- Specifically use, interface with, or provide complementary capabilities to other Astropy packages. | ||
lwasser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Use classes and functions from the astropy core package wherever possible and appropriate, and (as much as possible) avoid duplication with other packages in the Astropy ecosystem. This facilitates reuse of code and sharing of resources. | ||
|
||
### Ecointegration - Integration with the Astropy Ecosystem | ||
|
||
Your package should clearly integrate into the broader Astropy ecosystem. It should: | ||
|
||
- Use Astropy or other affiliated packages wherever possible | ||
lwasser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Use / depend upon astropy or other affiliated packages functionality wherever possible to avoid duplication of functionality across the ecosystem. | ||
|
||
## Long-term maintenance & affiliate status over time | ||
|
||
All packages accepted into the pyOpenSci ecosystem will follow the [pyOpenSci | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
policies](archive-process) associated with package maintenance. | ||
|
||
They will also need to follow the Astropy standards as follows: | ||
|
||
If packages become unmaintained or do not meet the standards anymore, they may be removed from the list of affiliated packages. | ||
|
||
This rule also applies to any package that applies for affiliated status with a | ||
specific domain community through the pyOpenSci partnership program. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ | |
|
||
About Our Partnerships <self> | ||
JOSS <joss> | ||
Astropy <astropy> | ||
Pangeo <pangeo> | ||
Comment on lines
9
to
12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great to see this list growing! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @namurphy i'm excited about it too!! we also just spoke with scverse!! |
||
::: | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't know you could do this in Markdown. Cool!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be a superpower of MyST . i really love MyST for all of our documentation and anything sphinx related. it's such a game changer in terms of flexibility / readability with simple syntax!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is
(astropy-collaboration)=
? What should I be expected to see with this directive in the rendered page?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh @pllim that is a myst target. it's a nice way to have a consistent target link in case someone changes header text and forgets and also to just make a nice short target link. so you can think of it as a shortcut to make cross linking to section headers within a sphinx document less error prone. i'm not sure it's visible in the final rendered page however just internally it's helpful in case people change header names.