From 6f6992643cb83111bff55a38d4a60491189cd47a Mon Sep 17 00:00:00 2001 From: Aritra Ghosh Date: Fri, 17 May 2024 19:39:24 -0700 Subject: [PATCH 1/3] Initial markdown commit of Readme --- README.md | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ef18795c5c --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +[![Status of Build and Tests Workflow](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml/badge.svg)](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml) + +[![Documentation Status](https://readthedocs.org/projects/gampen/badge/?version=latest)](https://gampen.readthedocs.io/en/latest/?badge=latest) + +[![Python Version 3.7 and above](https://img.shields.io/badge/Python-3.7%2B-blue)](https://www.python.org/downloads/) + +[![GitHub license](https://img.shields.io/github/license/aritraghsh09/GaMPEN)](https://github.com/aritraghsh09/GaMPEN/blob/master/LICENSE) + +[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + +[![Code DOI](https://zenodo.org/badge/299731956.svg)](https://zenodo.org/badge/latestdoi/299731956) + +[![Publication DOI](https://img.shields.io/badge/publication%20doi-10.3847%2F1538--4357%2Fac7f9e-blue)](https://doi.org/10.3847/1538-4357/ac7f9e) + +[![arXiv](https://img.shields.io/badge/arXiv-2207.05107-blue)](https://arxiv.org/abs/2207.05107) + +
+ +![image](./intro_image.png) + +
+ +The Galaxy Morphology Posterior Estimation Network (GaMPEN) is a novel +machine learning framework for estimating the Bayesian posteriors (i.e., +values + uncertainties) of morphological parameters for arbitrarily +large numbers of galaxies. GaMPEN also automatically crops input galaxy +images to an optimal size before morphological parameter estimation. + +GaMPEN can be adapted to work on both ground and space-based imaging; +and to predict both parametric and non-parametric estimates of +morphology. + +Once trained, it takes GaMPEN less than a milli-second to perform a +single model evaluation on a CPU. Thus, GaMPEN's posterior prediction +capabilities are ready for large galaxy samples expected from upcoming +large imaging surveys, such as Rubin-LSST, Euclid, and NGRST. + +**For a quick read-through of why GaMPEN was developed, what challenges +it addresses, and how it works** see this +[link](http://www.astro.yale.edu/aghosh/gampen.html) + +# Documentation + +We are actively developing extensive documentation and tutorials for +GaMPEN. You can find the current state of our documentation and +tutorials at [this link](https://gampen.readthedocs.io/) . We hope to +have this fully completed by early Spring 2023. If you are trying to use +GaMPEN before that and run into issues, please get in touch! + +# Publication + +GaMPEN was initially introduced in this [ApJ +paper](https://iopscience.iop.org/article/10.3847/1538-4357/ac7f9e) + +An updated record of GaMPEN's trained models and catalogs produced are +maintained [here](http://gampen.ghosharitra.com/) + +Attribution Info. ------------Please cite the above mentioned +publication if you make use of this software module or some code herein. + +``` tex +@article{Ghosh2022, +author = {Aritra Ghosh and C. Megan Urry and Amrit Rau and Laurence Perreault-Levasseur and Miles Cranmer and Kevin Schawinski and Dominic Stark and Chuan Tian and Ryan Ofman and Tonima Tasnim Ananna and Connor Auge and Nico Cappelluti and David B. Sanders and Ezequiel Treister}, +doi = {10.3847/1538-4357/ac7f9e}, +issn = {0004-637X}, +issue = {2}, +journal = {The Astrophysical Journal}, +month = {8}, +pages = {138}, +title = {GaMPEN: A Machine-learning Framework for Estimating Bayesian Posteriors of Galaxy Morphological Parameters}, +volume = {935}, +year = {2022}, +} +``` + +Additionally, if you want, please include the following text in the +Software/Acknowledgment section. + +``` tex +This work uses trained models/software made available as a part of the Galaxy Morphology Posterior Estimation Network public data release. +``` + +# License + +Copyright 2022 Aritra Ghosh, Amrit Rau & contributors + +Made available under a [GNU GPL +v3.0](https://github.com/aritraghsh09/GaMPEN/blob/master/LICENSE) +license. + +# Contributors + +GaMPEN was initially developed by [Amrit Rau](https://amritrau.xyz/) and +[Aritra Ghosh](http://www.ghosharitra.com/) + +The initial documentation was developed by [Aayush +Mishra](https://github.com/aayush2505) and [Aritra +Ghosh](http://www.ghosharitra.com/) + +For an updated list of all current contributors, please see +[here](https://github.com/aritraghsh09/GaMPEN/graphs/contributors) + +# Getting Help/Contributing + +If you have a question, please send me an e-mail at this +`aritraghsh09@xxxxx.com` GMail address. + +If you have spotted a bug in the code/documentation or you want to +propose a new feature, please feel free to open an issue/a pull request +on GitHub. From 5739721a784410379a78d9ea43ead1ffc709c04a Mon Sep 17 00:00:00 2001 From: Aritra Ghosh Date: Fri, 17 May 2024 19:41:32 -0700 Subject: [PATCH 2/3] Formatting changes --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index ef18795c5c..5be41b6345 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,11 @@ [![Status of Build and Tests Workflow](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml/badge.svg)](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml) - [![Documentation Status](https://readthedocs.org/projects/gampen/badge/?version=latest)](https://gampen.readthedocs.io/en/latest/?badge=latest) - [![Python Version 3.7 and above](https://img.shields.io/badge/Python-3.7%2B-blue)](https://www.python.org/downloads/) - [![GitHub license](https://img.shields.io/github/license/aritraghsh09/GaMPEN)](https://github.com/aritraghsh09/GaMPEN/blob/master/LICENSE) - [![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) - [![Code DOI](https://zenodo.org/badge/299731956.svg)](https://zenodo.org/badge/latestdoi/299731956) - [![Publication DOI](https://img.shields.io/badge/publication%20doi-10.3847%2F1538--4357%2Fac7f9e-blue)](https://doi.org/10.3847/1538-4357/ac7f9e) -[![arXiv](https://img.shields.io/badge/arXiv-2207.05107-blue)](https://arxiv.org/abs/2207.05107) -
![image](./intro_image.png) From 8911c6154e2bdd357a80f5c1473456d1987e61b2 Mon Sep 17 00:00:00 2001 From: Aritra Ghosh Date: Fri, 17 May 2024 20:02:17 -0700 Subject: [PATCH 3/3] Update README.md Updates to text and formatting --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5be41b6345..83d6b9bf8e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Code DOI](https://zenodo.org/badge/299731956.svg)](https://zenodo.org/badge/latestdoi/299731956) [![Publication DOI](https://img.shields.io/badge/publication%20doi-10.3847%2F1538--4357%2Fac7f9e-blue)](https://doi.org/10.3847/1538-4357/ac7f9e) +[![arXiv](https://img.shields.io/badge/arXiv-2207.05107-blue)](https://arxiv.org/abs/2207.05107)
@@ -18,7 +19,9 @@ values + uncertainties) of morphological parameters for arbitrarily large numbers of galaxies. GaMPEN also automatically crops input galaxy images to an optimal size before morphological parameter estimation. -GaMPEN can be adapted to work on both ground and space-based imaging; +GaMPEN's predicted uncertainties have been shown to be upto ~60% +more accurate compared to traditional light-profile fitting codes. GaMPEN +can be adapted to work on both ground and space-based imaging; and to predict both parametric and non-parametric estimates of morphology. @@ -29,15 +32,14 @@ large imaging surveys, such as Rubin-LSST, Euclid, and NGRST. **For a quick read-through of why GaMPEN was developed, what challenges it addresses, and how it works** see this -[link](http://www.astro.yale.edu/aghosh/gampen.html) +[link](http://gampen.ghosharitra.com/) # Documentation -We are actively developing extensive documentation and tutorials for -GaMPEN. You can find the current state of our documentation and -tutorials at [this link](https://gampen.readthedocs.io/) . We hope to -have this fully completed by early Spring 2023. If you are trying to use -GaMPEN before that and run into issues, please get in touch! +GaMPEN's documentation is available in this repository and also hosted +on [readthedocs.io](https://gampen.readthedocs.io/) . Although the documentation +is fairly complete; if you are trying to use GaMPEN and run into issues, +please get in touch with us! # Publication @@ -47,8 +49,9 @@ paper](https://iopscience.iop.org/article/10.3847/1538-4357/ac7f9e) An updated record of GaMPEN's trained models and catalogs produced are maintained [here](http://gampen.ghosharitra.com/) -Attribution Info. ------------Please cite the above mentioned -publication if you make use of this software module or some code herein. +## Attribution Info. +Please cite the above-mentioned publication if you make use of this software +module or some code herein. ``` tex @article{Ghosh2022, @@ -65,13 +68,6 @@ year = {2022}, } ``` -Additionally, if you want, please include the following text in the -Software/Acknowledgment section. - -``` tex -This work uses trained models/software made available as a part of the Galaxy Morphology Posterior Estimation Network public data release. -``` - # License Copyright 2022 Aritra Ghosh, Amrit Rau & contributors