-
Notifications
You must be signed in to change notification settings - Fork 35
swiftgalaxy #244
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
Comments
Editor in Chief checksHi there! Thank you for submitting your package for pyOpenSci Please check our Python packaging guide for more information on the elements
Editor commentsGiven the astronomy nature of this package, would you like to also pursue Astropy as well? Please address the following: Package DependencyPlease emphasize the requirement for NumPy >= 2.0 READMEPlease add installation instructions: Please show a brief example of the package in action: Please add a community section: Please add a section that links to the gallery/alternative tutorials. Please update the repository information to add the readthedocs webpage. https://swiftgalaxy.readthedocs.io/en/latest/ Should be here: (Sorry, there's only a "topics" help page for showing this... But, it's in the same location!) Package websitePlease try to organize the landing page with: Example: https://www.fatiando.org/verde/latest/ Please consider placing tutorials under a clear website section, c.f. Example: https://www.fatiando.org/verde/latest/gallery/index.html# Or, see the "User Guide" portion on the left hand side bar. Please make available a way to obtain example data, e.g. https://swiftgalaxy.readthedocs.io/en/latest/getting_started/index.html#quick-start ActionPlease take the necessary steps to address the README file and website requirements. We cannot send the package onto a later stage until these issues are addressed as our reviewers and your future users will need to be able to more easily navigate the documentation. |
This package seems to be astronomy-focussed and the source code does have astropy as a dependency. So, I wonder if it makes sense to treat this as an astropy/astronomy related package; to me it looks like that would make sense, but the authors have not set the tick-box for "astropy community". @kyleaoman: Just checking if that's intentional or should we add it? |
@hamogu As far as I understand the astropy community packages look for use of astropy features where this is relevant, which is not really the case for this package. For example, |
Great, thanks for the fast reply; I agree. I just wanted to check to make sure we don't overlook it! |
@kyleaoman thank you for the clarifications! |
Just so I can keep track:
|
Uh oh!
There was an error while loading. Please reload this page.
Submitting Author: @kyleaoman
All current maintainers: @kyleaoman
Package Name: swiftgalaxy
One-Line Description of Package: Load in particles of a simulated galaxy, rotate coordinates, easy spherical/cylindrical coordinates, access integrated properties, and more.
Repository Link: https://github.com/SWIFTSIM/swiftgalaxy
Version submitted: 2.0.3
EiC: @coatless
Editor: TBD
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD
Code of Conduct & Commitment to Maintain Package
Description
SWIFTGalaxy is a module that extends SWIFTSimIO tailored to analyses of particles belonging to individual simulated galaxies. It inherits from and extends the functionality of the SWIFTDataset. It understands the content of halo catalogues (supported: Velociraptor, Caesar, SOAP) and therefore which particles belong to a galaxy or other group of particles, and its integrated properties. The particles occupy a coordinate frame that is enforced to be consistent, such that particles loaded on-the-fly will match e.g. rotations and translations of particles already in memory. Intuitive masking of particle datasets is also enabled. Finally, some utilities to make working in cylindrical and spherical coordinate systems more convenient are also provided.
Scope
Please indicate which category or categories.
Check out our package scope page to learn more about our
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
Domain Specific
Community Partnerships
If your package is associated with an
existing community please check below:
For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
Who is the target audience and what are scientific applications of this package? The package is for scientists analysing SWIFT simulations of galaxies. It facilitates extracting a subset of a simulation containing many galaxies that corresponds to a single galaxy and manipulating the data.
Are there other Python packages that accomplish the same thing? If so, how does yours differ? pynbody has some points in common, but swiftgalaxy is specifically designed for SWIFT simulations by (i) using swiftsimio as a backend and (ii) having features that leverage the particular data layout and metadata annotations of SWIFT outputs.
If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@tag
the editor you contacted:Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication Options
JOSS Checks
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
. I expect to have this in place before PyOpenSci review is completedNote: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.
Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Confirm each of the following by checking the box.
Please fill out our survey
submission and improve our peer review process. We will also ask our reviewers
and editors to fill this out. completed on a previous submission, I think that I don't need to complete it again?
P.S. Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
The editor template can be found here.
The review template can be found here.
Footnotes
Please fill out a pre-submission inquiry before submitting a data visualization package. ↩
The text was updated successfully, but these errors were encountered: