Skip to content

Commit 1181443

Browse files
thomaswilliamsastrothomaswilliamsastro
committed
Wrap into pip-installable package
- Fix step occasionally being 0 in noise cube generation - Add dependabot, and build actions to ensure package installs correctly on Python matrix - Add CODEOWNERS, so PRs get assigned automatically - Update CITATION.md to CITATION.cff, and format correctly - Rename LICENSE.rst to just LICENSE - Rewrite pyproject.toml to allow pip-installation - Expand list of authors/maintainers/citation.cff - Rename README.rst to README.md - Significant reformatting and updating to reflect packaging - Include details on chunked imaging - Remove setup.cfg/setup.py - Remove unused _astropy_init.py - Remove unused conftest.py - Remove unused data/ directory in phangsPipeline - Remove unused and very outdated PHANGSPipelineReadme.md in phangsPipeline - Moved casaBlankCleanRecipe to scripts, and renamed - Refactored versioning throughout, now pulls automatically from the package - Fully align CASA version throughout - General import tidy-up - Move various example scripts into scripts/ directory - Consolidate run script into run_pipeline_phangs-alma.py
1 parent 4971112 commit 1181443

File tree

98 files changed

+6562
-7508
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+6562
-7508
lines changed

‎.github/dependabot.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
target-branch: "master"
11+
schedule:
12+
interval: "weekly"
13+
14+
# Maintain dependencies for pip
15+
- package-ecosystem: "pip"
16+
directory: "/"
17+
target-branch: "master"
18+
schedule:
19+
interval: "weekly"
20+
open-pull-requests-limit: 10

‎.github/workflows/build.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
job:
13+
name: Build
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
# Versions listed at https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
18+
python-version: [
19+
"3.12",
20+
]
21+
steps:
22+
- uses: actions/checkout@v6
23+
with:
24+
submodules: true
25+
- name: Setup Python ${{ matrix.python-version }}
26+
uses: actions/setup-python@v6
27+
with:
28+
python-version: ${{ matrix.python-version }}
29+
- name: Install dependencies
30+
run: |
31+
python -m pip install --upgrade pip
32+
pip install build
33+
pip install .
34+
pip install .[casa]
35+
- name: Build package
36+
run: python -m build

‎.github/workflows/publish.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Build and upload to PyPI
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build_sdist_and_wheel:
7+
name: Build source distribution
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v6
11+
- uses: actions/setup-python@v6
12+
name: Install Python
13+
with:
14+
python-version: "3.12"
15+
- name: Install build
16+
run: python -m pip install build
17+
- name: Build sdist
18+
run: python -m build --sdist --wheel --outdir dist/ .
19+
- uses: actions/upload-artifact@v6
20+
with:
21+
path: dist/*
22+
23+
# upload_pypi:
24+
# name: Upload to PyPI
25+
# needs: [build_sdist_and_wheel]
26+
# runs-on: ubuntu-latest
27+
# if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
28+
# steps:
29+
# - uses: actions/download-artifact@v7
30+
# with:
31+
# name: artifact
32+
# path: dist
33+
# - uses: pypa/gh-action-pypi-publish@release/v1
34+
# with:
35+
# user: __token__
36+
# password: ${{ secrets.PYPI_API_TOKEN }}

‎CITATION.cff‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
title: "phangsPipeline"
4+
authors:
5+
- family-names: "Leroy"
6+
given-names: "Adam"
7+
- family-names: "Hughes"
8+
given-names: "Annie"
9+
- family-names: "Liu"
10+
given-names: "Daizhong"
11+
- family-names: "Pety"
12+
given-names: "Jerome"
13+
- family-names: "Rosolowsky"
14+
given-names: "Erik"
15+
- family-names: "Saito"
16+
given-names: "Toshiki"
17+
- family-names: "Schinnerer"
18+
given-names: "Eva"
19+
- family-names: "Schruba"
20+
given-names: "Andreas"
21+
- family-names: "Usero"
22+
given-names: "Antonio"
23+
- family-names: "Faesi"
24+
given-names: "Christopher"
25+
- family-names: "Herrera"
26+
given-names: "Cinthya"
27+
- family-names: "Chevance"
28+
given-names: "Melanie"
29+
- family-names: "Hygate"
30+
given-names: "Christopher"
31+
- family-names: "Kepley"
32+
given-names: "Amanda"
33+
- family-names: "Koch"
34+
given-names: "Eric"
35+
- family-names: "Querejeta"
36+
given-names: "Miguel"
37+
- family-names: "Sliwa"
38+
given-names: "Kazimierz"
39+
- family-names: "Will"
40+
given-names: "David"
41+
- family-names: "Wilson"
42+
given-names: "Christine"
43+
- family-names: "Anand"
44+
given-names: "Gagandeep"
45+
- family-names: "Barnes"
46+
given-names: "Ashley"
47+
- family-names: "Belfiore"
48+
given-names: "Francesco"
49+
- family-names: "Beslic"
50+
given-names: "Ivana"
51+
- family-names: "Bigiel"
52+
given-names: "Frank"
53+
- family-names: "Blanc"
54+
given-names: "Guillermo"
55+
- family-names: "Bolatto"
56+
given-names: "Alberto"
57+
- family-names: "Boquien"
58+
given-names: "Mederic"
59+
- family-names: "Cao"
60+
given-names: "Yixian"
61+
- family-names: "Chandar"
62+
given-names: "Rupali"
63+
- family-names: "Chastenet"
64+
given-names: "Jeremy"
65+
- family-names: "Chiang"
66+
given-names: "I-Da"
67+
- family-names: "Congiu"
68+
given-names: "Enrico"
69+
- family-names: "Dale"
70+
given-names: "Daniel"
71+
- family-names: "Deger"
72+
given-names: "Sinan"
73+
- family-names: "den Brok"
74+
given-names: "Jakob"
75+
- family-names: "Eibensteiner"
76+
given-names: "Cosima"
77+
- family-names: "Emsellem"
78+
given-names: "Eric"
79+
- family-names: "Garcia-Rodriguez"
80+
given-names: "Axel"
81+
- family-names: "Kim"
82+
given-names: "Jaeyeon"
83+
- family-names: "Klessen"
84+
given-names: "Ralf"
85+
- family-names: "Kreckel"
86+
given-names: "Kathryn"
87+
- family-names: "Kruijssen"
88+
given-names: "Diederik"
89+
- family-names: "Larson"
90+
given-names: "Kirsten"
91+
- family-names: "Lee"
92+
given-names: "Janice"
93+
- family-names: "Mayker"
94+
given-names: "Ness"
95+
- family-names: "McElroy"
96+
given-names: "Rebecca"
97+
- family-names: "Meidt"
98+
given-names: "Sharon"
99+
- family-names: "Mok"
100+
given-names: "Angus"
101+
- family-names: "Pan"
102+
given-names: "Hsi-An"
103+
- family-names: "Puschnig"
104+
given-names: "Johannes"
105+
- family-names: "Razza"
106+
given-names: "Alessandro"
107+
- family-names: "Sanchez-Blazquez"
108+
given-names: "Patricia"
109+
- family-names: "Sandstrom"
110+
given-names: "Karin"
111+
- family-names: "Santoro"
112+
given-names: "Francesco"
113+
- family-names: "Sardone"
114+
given-names: "Amy"
115+
- family-names: "Scheuermann"
116+
given-names: "Fabian"
117+
- family-names: "Sun"
118+
given-names: "Jiayi"
119+
- family-names: "Thilker"
120+
given-names: "David"
121+
- family-names: "Turner"
122+
given-names: "Jordan"
123+
- family-names: "Ubeda"
124+
given-names: "Leonardo"
125+
- family-names: "Utomo"
126+
given-names: "Dyas"
127+
- family-names: "Watkins"
128+
given-names: "Elizabeth"
129+
- family-names: "Williams"
130+
given-names: "Thomas"
131+
version: 4.0.0
132+
doi: "10.3847/1538-4365/abec80"
133+
url: "https://github.com/akleroy/phangs_imaging_scripts/"

‎CITATION.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Specify a default Code Owner for all files with a wildcard:
2+
* @thomaswilliamsastro

LICENSE.rst renamed to LICENSE

File renamed without changes.

0 commit comments

Comments
 (0)