From a56242e00117331c86d4c669f838a083e5a9e967 Mon Sep 17 00:00:00 2001 From: Connor Stone Date: Wed, 18 Dec 2024 09:17:34 -0500 Subject: [PATCH 1/2] remove repostats workflow --- .../workflows/repostats-for-nice-project.yml | 23 ------------------- 1 file changed, 23 deletions(-) delete mode 100644 .github/workflows/repostats-for-nice-project.yml diff --git a/.github/workflows/repostats-for-nice-project.yml b/.github/workflows/repostats-for-nice-project.yml deleted file mode 100644 index c45ea54e..00000000 --- a/.github/workflows/repostats-for-nice-project.yml +++ /dev/null @@ -1,23 +0,0 @@ - - - -on: - schedule: - # Run this once per day, towards the end of the day for keeping the most - # recent data point most meaningful (hours are interpreted in UTC). - - cron: "0 23 * * *" - workflow_dispatch: # Allow for running this manually. - -jobs: - j1: - name: repostats-for-nice-project - runs-on: ubuntu-latest - steps: - - name: run-ghrs - uses: jgehrcke/github-repo-stats@v1.3.0 - with: - # Set a GitHub API token that can read the stats - # repository, and that can push to the data - # repository (which this workflow file lives in), - # to store data and the report files. - ghtoken: ${{ secrets.ghrs_github_api_token }} From 7c82470d1a83b7cedaa506b324f71a2e1d8335f8 Mon Sep 17 00:00:00 2001 From: Connor Stone Date: Wed, 18 Dec 2024 09:30:27 -0500 Subject: [PATCH 2/2] fix CD, more info on psf deconvolve --- .github/workflows/cd.yaml | 5 +++-- README.md | 2 +- autoprof/pipeline_steps/PSF.py | 4 ++++ docs/extramethods.rst | 6 +++++- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/workflows/cd.yaml b/.github/workflows/cd.yaml index c368bdea..48267427 100644 --- a/.github/workflows/cd.yaml +++ b/.github/workflows/cd.yaml @@ -58,7 +58,7 @@ jobs: ls -ltrh ls -ltrh dist - name: Publish to Test PyPI - uses: pypa/gh-action-pypi-publish@v1.9.0 + uses: pypa/gh-action-pypi-publish@v1.12.2 with: repository-url: https://test.pypi.org/legacy/ verbose: true @@ -67,6 +67,7 @@ jobs: run: | sleep 3 python -m pip install --upgrade pip + python -m pip install --upgrade pkginfo echo "=== Testing wheel file ===" # Install wheel to get dependencies and check import @@ -96,5 +97,5 @@ jobs: name: artifact path: dist - - uses: pypa/gh-action-pypi-publish@v1.9.0 + - uses: pypa/gh-action-pypi-publish@v1.12.2 if: startsWith(github.ref, 'refs/tags') diff --git a/README.md b/README.md index 5c661c23..f82aa9d4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Its design allows for fast startup and provides flexibility to explore new ideas It was written by [Connor Stone](https://connorjstone.com/) with contributions from [Nikhil Arora](https://orcid.org/0000-0002-3929-9316), [Stephane Courteau](https://www.physics.queensu.ca/facultysites/courteau/), -and [Jean-Charles Cuillandre](https://www.cfht.hawaii.edu/~jcc/). +[Jean-Charles Cuillandre](https://www.cfht.hawaii.edu/~jcc/), and now more (see the GitHub contributors). # Install diff --git a/autoprof/pipeline_steps/PSF.py b/autoprof/pipeline_steps/PSF.py index c7e62205..2b1b9726 100644 --- a/autoprof/pipeline_steps/PSF.py +++ b/autoprof/pipeline_steps/PSF.py @@ -426,6 +426,10 @@ def PSF_deconvolve(IMG, results, options): number of itterations of the Richardson-Lucy deconvolution algorithm to perform. + ap_psf_deconvolve_save : string, default None + Optional argument. Path to save the deconvolved FITS image. If not + given, the image will not be saved. + Notes ---------- :References: diff --git a/docs/extramethods.rst b/docs/extramethods.rst index c32de8df..930adc3a 100644 --- a/docs/extramethods.rst +++ b/docs/extramethods.rst @@ -61,7 +61,11 @@ PSF - Deconvolve :func:`~autoprof.pipeline_steps.PSF.PSF_deconvolve` -Deconvolves a provided PSF from the primary image. +Deconvolves a provided PSF from the primary image. Add the step 'psf deconvolve' +early in the pipeline steps and the primary image will be deconvolved using +Lucy-Richardson deconvolution. This is an approximate deconvolution useful in +many scenarios, but it depends on the number of iterations. You can use +`ap_psf_deconvolution_iterations` to set the number of iterations. Center - Mean ----------------------------------------------------------------------