You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,21 @@
1
+
# Community Guidelines
2
+
3
+
We strive to maintain a welcoming, respectful, and inclusive community. All contributors—whether opening issues, submitting pull requests, reviewing code, or participating in discussions—are expected to follow these guidelines.
4
+
5
+
- Be respectful and considerate of others.
6
+
- Assume good intent and be patient, especially with newcomers.
7
+
- Keep feedback constructive and focused on the work, not the person.
8
+
- Communicate clearly and professionally.
9
+
- Respect maintainers’ time and decisions.
10
+
11
+
Harassment, discrimination, or abusive behavior of any kind will not be tolerated.
12
+
13
+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
14
+
15
+
### Reporting concerns
16
+
If you experience or witness behavior that violates these guidelines or the Code of Conduct, please contact the project maintainers privately.
17
+
18
+
1
19
# Contributing
2
20
3
21
Contributions are welcome and greatly appreciated!
@@ -74,3 +92,4 @@ Before you submit a pull request, check that it meets these guidelines:
74
92
75
93
1. The pull request should include new tests for all the core routines that have been developed.
76
94
2. If the pull request adds functionality, the docs should be updated accordingly.
**PyAutoGalaxy** is software for analysing the morphologies and structures of galaxies:
@@ -54,7 +54,7 @@ The following links are useful for new starters:
54
54
55
55
- `The PyAutoGalaxy readthedocs <https://pyautogalaxy.readthedocs.io/en/latest>`_, which includes `an overview of PyAutoGalaxy's core features <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_1_start_here.html>`_, `a new user starting guide <https://pyautogalaxy.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>`_ and `an installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/overview.html>`_.
56
56
57
-
- `The introduction Jupyter Notebook on Binder <https://mybinder.org/v2/gh/Jammy2211/autogalaxy_workspace/release?filepath=start_here.ipynb>`_, where you can try **PyAutoGalaxy** in a web browser (without installation).
57
+
- `The introduction Jupyter Notebook on Google Colab <https://colab.research.google.com/github/Jammy2211/autogalaxy_workspace/blob/release/start_here.ipynb>`_, where you can try **PyAutoGalaxy** in a web browser (without installation).
58
58
59
59
- `The autogalaxy_workspace GitHub repository <https://github.com/Jammy2211/autogalaxy_workspace>`_, which includes example scripts and the `HowToGalaxy Jupyter notebook lectures <https://github.com/Jammy2211/autogalaxy_workspace/tree/main/notebooks/howtogalaxy>`_ which give new users a step-by-step introduction to **PyAutoGalaxy**.
60
60
@@ -63,149 +63,43 @@ Core Aims
63
63
64
64
**PyAutoGalaxy** has three core aims:
65
65
66
-
- **Model Complexity**: Fitting complex galaxy morphology models (e.g. Multi Gaussian Expansion, Shapelets, Ellipse Fitting, Irregular Meshes) that go beyond just simple Sersic fitting (which is supported too!).
66
+
- **Big Data**: Scaling automated Sérsic fitting to extremely large datasets, *accelerated with JAX on GPUs and using tools like an SQL database to **build a scalable scientific workflow***.
67
67
68
-
- **Data Variety**: Support for many data types (e.g. CCD imaging, interferometry, multi-band imaging) which can be fitted independently or simultaneously.
68
+
- **Model Complexity**: Fitting complex galaxy morphology models (e.g. Multi Gaussian Expansion, Shapelets, Ellipse Fitting, Irregular Meshes) that go beyond just simple Sérsic fitting.
69
69
70
-
- **Big Data**: Scaling automated analysis to extremely large datasets, using tools like an SQL database to build a scalable scientific workflow.
70
+
- **Data Variety**: Support for many data types (e.g. CCD imaging, interferometry, multi-band imaging) which can be fitted independently or simultaneously.
71
71
72
72
A complete overview of the software's aims is provided in our `Journal of Open Source Software paper <https://joss.theoj.org/papers/10.21105/joss.04475>`_.
73
73
74
-
API Overview
74
+
Community & Support
75
+
-------------------
76
+
77
+
Support for **PyAutoGalaxy** is available via our Slack workspace, where the community shares updates, discusses
78
+
galaxy modeling and analysis, and helps troubleshoot problems.
79
+
80
+
Slack is invitation-only. If you’d like to join, please send an email requesting an invite.
81
+
82
+
For installation issues, bug reports, or feature requests, please raise an issue on the [GitHub issues page](https://github.com/Jammy2211/PyAutoGalaxy/issues).
83
+
84
+
Here’s a clean, **AutoGalaxy**-appropriate rewrite, keeping the same structure and tone but removing lensing-specific language:
85
+
86
+
HowToGalaxy
87
+
-----------
88
+
89
+
For users less familiar with galaxy analysis, Bayesian inference, and scientific analysis, you may wish to read through
90
+
the **HowToGalaxy** lectures. These introduce the basic principles of galaxy modeling and Bayesian inference, with
91
+
the material pitched at undergraduate level and above.
92
+
93
+
A complete overview of the lectures is provided on the `HowToGalaxy readthedocs page <https://pyautogalaxy.readthedocs.io/en/latest/howtogalaxy/howtogalaxy.html`_
94
+
95
+
Citations
96
+
---------
97
+
98
+
Information on how to cite **PyAutoGalaxy** in publications can be found `on the citations page <https://github.com/Jammy2211/PyAutoGalaxy/blob/main/CITATIONS.rst>`_.
99
+
100
+
Contributing
75
101
------------
76
102
77
-
Galaxy morphology calculations are performed in **PyAutoGalaaxy** by building a ``Plane`` object from ``LightProfile``
78
-
and ``Galaxy`` objects. We create a simple galaxy system where a redshift 0.5
79
-
``Galaxy`` with an ``Sersic`` ``LightProfile`` representing a bulge and an ``Exponential`` ``LightProfile``
80
-
representing a disk.
81
-
82
-
.. code-block:: python
83
-
84
-
import autogalaxy as ag
85
-
import autogalaxy.plot as aplt
86
-
87
-
"""
88
-
To describe the galaxy emission two-dimensional grids of (y,x) Cartesian
89
-
coordinates are used.
90
-
"""
91
-
grid = ag.Grid2D.uniform(
92
-
shape_native=(50, 50),
93
-
pixel_scales=0.05, # <- Conversion from pixel units to arc-seconds.
94
-
)
95
-
96
-
"""
97
-
The galaxy has an elliptical sersic light profile representing its bulge.
To perform the model-fit we pass the model and analysis to the search's fit method. This will
192
-
output results (e.g., dynesty samples, model parameters, visualization) to hard-disk.
193
-
"""
194
-
result = search.fit(model=model, analysis=analysis)
195
-
196
-
"""
197
-
The results contain information on the fit, for example the maximum likelihood
198
-
model from the Dynesty parameter space search.
199
-
"""
200
-
print(result.samples.max_log_likelihood())
201
-
202
-
203
-
Support
204
-
-------
205
-
206
-
Support for installation issues, help with galaxy modeling and using **PyAutoGalaxy** is available by
207
-
`raising an issue on the GitHub issues page <https://github.com/Jammy2211/PyAutoGalaxy/issues>`_.
208
-
209
-
We also offer support on the **PyAutoGalaxy** `Slack channel <https://pyautogalaxy.slack.com/>`_, where we also provide the
210
-
latest updates on **PyAutoGalaxy**. Slack is invitation-only, so if you'd like to join send
211
-
an `email <https://github.com/Jammy2211>`_ requesting an invite.
103
+
Information on how to contribute to **PyAutoGalaxy** can be found `on the contributing page <https://github.com/Jammy2211/PyAutoGalaxy/blob/main/CONTRIBUTING.md>`_.
104
+
105
+
Hands on support for contributions is available via our Slack workspace, again please email to request an invite.
0 commit comments