Skip to content

PyAutoGalaxy #235

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

Open
16 of 28 tasks
Jammy2211 opened this issue Mar 13, 2025 · 2 comments
Open
16 of 28 tasks

PyAutoGalaxy #235

Jammy2211 opened this issue Mar 13, 2025 · 2 comments
Labels
2/seeking-reviewers astropy An astropy community affiliated package review

Comments

@Jammy2211
Copy link

Jammy2211 commented Mar 13, 2025

Submitting Author: (@Jammy2211)
All current maintainers: (@Jammy2211)
Package Name: PyAutoGalaxy
One-Line Description of Package: Astronomy software for analysing the morphologies and structures of galaxies
Repository Link: https://github.com/Jammy2211/PyAutoGalaxy
Version submitted: 2025.1.18.7
EiC: @coatless
Editor: @hamogu
Reviewer 1: @canorve
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

Nearly a century ago, Edwin Hubble famously classified galaxies into three distinct groups: ellipticals, spirals and irregulars [@Hubble1926]. Today, by analysing millions of galaxies with advanced image processing techniques Astronomers have expanded on this picture and revealed the rich diversity of galaxy morphology in both the nearby and distant Universe [@Kormendy2015a; @Vulcani2014; @VanDerWel2012]. PyAutoGalaxy is an open-source Python 3.8 - 3.11 package for analysing the morphologies and structures of large multiwavelength galaxy samples, with core features including fully automated Bayesian model-fitting of galaxy two-dimensional surface brightness profiles, support for dataset and interferometer datasets and comprehensive tools for simulating galaxy images. The software places a focus on big data analysis, including support for hierarchical models that simultaneously fit thousands of galaxies, massively parallel model-fitting and an SQLite3 database that allows large suites of modeling results to be loaded, queried and analysed.

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:

  • 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?

Astronomers studying the morphology of galaxies, and undergraduates / people interested in learning how to do science with galaxies. The package analyses galaxy images (e.g. from the James Webb Space Telescope) and extracts information on them.

  • Are there other Python packages that accomplish the same thing? If so, how does yours differ?

Many: pysersic, GALFIT, ProFit, to name a few.

PyAutoGalaxy supports a more diverse range of ways to analysis galaxy images and has support for Bayesian inference on big data (e.g. sqlite database, graphical modeling) other packages do not.

  • 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:

This package was first submited to astropy years ago, then was to be moved to PyOpenSci, this PR discussion shows that: astropy/astropy.github.com#491

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

Already Published in JOSS: https://joss.theoj.org/papers/10.21105/joss.04475

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

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

  1. Please fill out a pre-submission inquiry before submitting a data visualization package.

@lwasser lwasser moved this to pre-review-checks in peer-review-status Mar 13, 2025
@dhomeier dhomeier added the astropy An astropy community affiliated package review label Mar 13, 2025
@coatless
Copy link

Editor in Chief checks

Hi there! Thank you for submitting your package for pyOpenSci
review. Below are the basic checks that your package needs to pass
to begin our review. If some of these are missing, we will ask you
to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements
below.

  • Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
    • The package imports properly into a standard Python environment import package.
  • Fit The package meets criteria for fit and overlap.
  • Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
    • User-facing documentation that overviews how to install and start using the package.
    • Short tutorials that help a user understand how to use the package and what it can do for them.
    • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
  • Core GitHub repository Files
    • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
    • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
    • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
    • License The package has an OSI approved license.
      NOTE: We prefer that you have development instructions in your documentation too.
  • Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
  • Automated tests Package has a testing suite and is tested via a Continuous Integration service.
  • Repository The repository link resolves correctly.
  • Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
  • Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
  • Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

  • Initial onboarding survey was filled out
    We appreciate each maintainer of the package filling out this survey individually. 🙌
    Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌


Editor comments

Thanks for submitting PyAutoGalaxy to pyOpenSci! The package is in ship shape to move forward with our review process. The documentation and functionality is excellent! Well done on creating actionable streams to get users immediately able to analyzing morphoologies and structures of galaxies!

The only minor nit is a section in the README.md clearly labeled as "Installation Instructions". That said, this is largely covered by "Installation Guide" link. However, it would be great if you could include a brief separate snippet. Though, I'm going to go ahead and move the process along by assigning to @hamogu.

@lwasser lwasser moved this from pre-review-checks to under-review in peer-review-status Apr 14, 2025
@hamogu
Copy link

hamogu commented Apr 15, 2025

Editor response to review:

Hi @Jammy2211! Thanks for submitting your package to PyOpenSci. I'll be your editor - please feel free to reach out to me with any questions you might have. I'll now start to look for reviewers; usually that's the most time-consuming part of the process but I'll keep you updated as that goes along!


Editor comments

👋 Hi @reviewer-one and @reviewer-two! Thank you for volunteering to review
for pyOpenSci!

Please fill out our pre-review survey

Before beginning your review, please fill out our pre-review survey. This helps us improve all aspects of our review and better understand our community. No personal data will be shared from this survey - it will only be used in an aggregated format by our Executive Director to improve our processes and programs.

  • reviewer 1 survey completed.
  • reviewer 2 survey completed.
  • reviewer 3 (if applicable)

The following resources will help you complete your review:

  1. Here is the reviewers guide. This guide contains all of the steps and information needed to complete your review.
  2. Here is the review template that you will need to fill out and submit
    here as a comment, once your review is complete.

Please get in touch with any questions or concerns! Your review is due:

Reviewers: @canorve
Due date:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2/seeking-reviewers astropy An astropy community affiliated package review
Projects
Status: under-review
Development

No branches or pull requests

4 participants