Description
Submitting Author: Manuel Alcázar-Laynez (@Manalclay)
All current maintainers: (@Manalclay, @andonij)
Package Name: GALAssify
One-Line Description of Package: A Python package for visually classifying astronomical objects
Repository Link: https://gitlab.com/astrogal/GALAssify/
Version submitted: v1.0.1
EiC: Szymon Moliński (@SimonMolinsky )
Editor: Avik Basu (@ab93)
Reviewer 1: Akhil Krishna R (@akhilkrishnar0)
Reviewer 2: Erik Whiting (@erik-whiting)
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD
Code of Conduct & Commitment to Maintain Package
- I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package after should it be accepted.
- I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines.
Description
- Include a brief paragraph describing what your package does:
We present GALAssify, a customisable graphical tool that allows the user to visually inspect and characterise properties of astronomical objects in a simple way. GALAssify allows the user to save the results of the visual classification into a file using a list of previously defined tags based on the user's interests. A priori, it has been initially developed to tackle astrophysical problems but, due to its versatility, it could be easily adapted. For instance, this tool can be used to classify microscopy images from biological studies or be used in any other discipline.
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):- Data retrieval
- Data extraction
- Data processing/munging
- Data deposition
- Data validation and testing
- Data visualization1
- Workflow automation
- Citation management and bibliometrics
- Scientific software wrappers
- Database interoperability
Domain Specific
- Geospatial
- Education
Community Partnerships
If your package is associated with an
existing community please check below:
- Astropy:My package adheres to Astropy community standards
- Pangeo: My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook
-
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):
GALAssify allows the user to visualise and validate a large dataset of astronomical images (or of any other field) using a Graphical User Interface (GUI) to accomplish it using only a keyboard, a mouse or both. User can view the image of the object and a linked FITS image at time, and visually classify it with a previously-defined tags, or even discard the object if required.-
Who is the target audience and what are scientific applications of this package?
This package is designed for astronomers who need to manually classify large numbers of astronomical objects given their respective images using customizable labels. -
Are there other Python packages that accomplish the same thing? If so, how does yours differ?
Currently, we don't know any customizable GUI-based tool specific for astronomical objects. The most similar tools can be ML generic dataset-creation GUI tools such as image-sorter2 or DataTurks, but their functionality is limited for our use case. For example, our tool can display both RGB and FITS images of the same object at time to perform a better classification. Also, our tool can be used without mouse interaction -- all its functionality can be accessed using keyboard shortcuts, which is a essential speed-up in the workflow when classifying large datasets. -
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:
Presubmission Inquiry for GALAssify: A Python package for visually classifying astronomical objects #189
-
Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
- does not violate the Terms of Service of any service it interacts with.
- uses an OSI approved license.
- contains a README with instructions for installing the development version.
- includes documentation with examples for all functions.
- contains a tutorial with examples of its essential functions and uses.
- has a test suite.
- has continuous integration setup, such as GitHub Actions CircleCI, and/or others.
Publication Options
- Do you wish to automatically submit to the Journal of Open Source Software? If so:
JOSS Checks
- The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
- The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
- The package contains a
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
. - The package is deposited in a long-term repository with the DOI:
Note: 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.
- Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.
Confirm each of the following by checking the box.
- I have read the author guide.
- I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.
Please fill out our survey
- Last but not least please fill out our pre-review survey. This helps us track
submission and improve our peer review process. We will also ask our reviewers
and editors to fill this out.
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. ↩
Metadata
Metadata
Assignees
Type
Projects
Status