Merge pull request #767 from askap-vast/release-v1.1.1

Release v1.1.1

CHANGELOG.md

@@ -4,18 +4,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), with an added `List of PRs` section and links to the relevant PRs on the individual updates. This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/askap-vast/vast-pipeline/compare/v1.1.0...HEAD)
+## [1.1.1](https://github.com/askap-vast/vast-pipeline/releases/v1.1.1) (2024-10-15)
 
 #### Added
 
+- Added Zenodo DOI to README [#761](https://github.com/askap-vast/vast-pipeline/pull/762)
+
 #### Changed
 
+- Refreshed docs text [#766](https://github.com/askap-vast/vast-pipeline/pull/766)
+- Updated preferred citation to Zenodo DOI [#761](https://github.com/askap-vast/vast-pipeline/pull/762)
+
 #### Fixed
 
+- Removed errant <strong> tag from docs header [#766](https://github.com/askap-vast/vast-pipeline/pull/766)
+
 #### Removed
 
 #### List of PRs
 
+- [#766](https://github.com/askap-vast/vast-pipeline/pull/766): docs: Removed errant <strong> tag from docs header and refreshed docs text
+- [#761](https://github.com/askap-vast/vast-pipeline/pull/762): docs: Add Zenodo DOI
+
+
 ## [1.1.0](https://github.com/askap-vast/vast-pipeline/releases/v1.1.0) (2024-10-14)
 
 #### Added
@@ -57,6 +68,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### Changed
 
+- Updated README.md [#758](https://github.com/askap-vast/vast-pipeline/pull/758)
 - Force dask<2022.4.2, numpy<1.23, param<2.0 [#728](https://github.com/askap-vast/vast-pipeline/pull/728)
 - Bumped versions for github actions packages [#728](https://github.com/askap-vast/vast-pipeline/pull/728)
 - Changed pipeline.new_sources.parallel_get_rms_measurements to drop all but one RMS measurmeents [#730](https://github.com/askap-vast/vast-pipeline/pull/730)
@@ -141,6 +153,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### List of PRs
 
+- [#758](https://github.com/askap-vast/vast-pipeline/pull/758): docs: Updated README.md 
 - [#755](https://github.com/askap-vast/vast-pipeline/pull/755): fix: Fixed handling of NaNs and negatives in noise image statistics
 - [#754](https://github.com/askap-vast/vast-pipeline/pull/754): fix: Optimise YAML config parsing
 - [#725](https://github.com/askap-vast/vast-pipeline/pull/725): feat: Added further memory usage and timing debug logging 

README.md

@@ -1,23 +1,25 @@
 # VAST Pipeline
-
-<!-- created with https://shields.io/category/monitoring -->
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13927016.svg)](https://doi.org/10.5281/zenodo.13927016)
 [![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
-[![Nimbus](https://img.shields.io/website?down_color=red&down_message=offline&label=Nimbus&up_color=green&up_message=online&url=https%3A%2F%2Fdev.pipeline.vast-survey.org)](https://dev.pipeline.vast-survey.org)
 ![Tests](https://github.com/askap-vast/vast-pipeline/workflows/test-suite/badge.svg)
 [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://vast-survey.org/vast-pipeline/)
+[![Nimbus](https://img.shields.io/website?down_color=red&down_message=offline&label=Nimbus&up_color=green&up_message=online&url=https%3A%2F%2Fdev.pipeline.vast-survey.org)](https://dev.pipeline.vast-survey.org)
+<!-- created with https://shields.io/category/monitoring -->
+
+
 <!-- TODO: replace above with this below when repo is public -->
 <!-- ![Tests](https://img.shields.io/github/workflow/status/askap-vast/vast-pipeline/test-suite/master?label=Test%20Suite&logo=github) -->
 
 This repository holds the code of the VAST Pipeline, a radio transient detection pipeline for the ASKAP survey science project, VAST.
 
 Please read the [Installation Instructions](https://vast-survey.org/vast-pipeline/v1.0.0/gettingstarted/installation/). If you have any questions or feedback, we welcome you to open an [issue](https://github.com/askap-vast/vast-pipeline/issues). If you are interested in contributing to the code, please read and follow the [Contributing and Developing Guidelines](https://vast-survey.org/vast-pipeline/v1.0.0/developing/intro/).
 
-If using this tool in your research, please cite Murphy, et al. (2021).
+If using this tool in your research, please cite [10.5281/zenodo.13927015](https://doi.org/10.5281/zenodo.13927016).
 
 ## Features
 
 * Code base in `Python 3.8+`
-* Source association/manipulations using `Astropy4+` and `Pandas1+` dataframe
+* Source association/manipulations using `Astropy5+` and `Pandas1+` dataframe
 * Association methods: basic (`Astropy` crossmatch), advanced (search with a fixed distance), De Ruiter
 * Flagging of "New Source" and "Related Source"
 * Forced Extraction (Monitor) backward and forward in time
@@ -33,20 +35,26 @@ If using this tool in your research, please cite Murphy, et al. (2021).
 
 ## Contributors
 
-* Sergio Pintaldi – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
+### Active
+* Dougal Dobie – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/) and [OzGrav](https://www.ozgrav.org)
+* Tom Mauch – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
 * Adam Stewart – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/)
+
+### Former
+* Sergio Pintaldi – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
 * Andrew O'Brien – [Department of Physics, University of Wisconsin-Milwaukee](https://uwm.edu/physics/research/astronomy-gravitation-cosmology/)
 * Tara Murphy – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/)
 * David Kaplan – [Department of Physics, University of Wisconsin-Milwaukee](https://uwm.edu/physics/research/astronomy-gravitation-cosmology/)
-* Shibli Saleheen – [ADACS](https://adacs.org.au/who-we-are/our-team/)
-* David Liptai – [ADACS](https://adacs.org.au/who-we-are/our-team/)
-* Ella Xi Wang – [ADACS](https://adacs.org.au/who-we-are/our-team/)
+* Shibli Saleheen – [ADACS](https://adacs.org.au/)
+* David Liptai – [ADACS](https://adacs.org.au/)
+* Ella Xi Wang – [ADACS](https://adacs.org.au/)
 
 ## Acknowledgements
 
 The VAST Pipeline development was supported by:
 
 * The Australian Research Council through grants FT150100099 and DP190100561.
+* The Australian Research Council Centre of Excellence for Gravitational Wave Discovery (OzGrav), project numbers CE170100004 and CE230100016.
 * The Sydney Informatics Hub (SIH), a core research facility at the University of Sydney.
 * Software support resources awarded under the Astronomy Data and Computing Services (ADACS) Merit Allocation Program. ADACS is funded from the Astronomy National Collaborative Research Infrastructure Strategy (NCRIS) allocation provided by the Australian Government and managed by Astronomy Australia Limited (AAL).
 * NSF grant AST-1816492.

docs/faq.md

@@ -1,5 +1,9 @@
 # Frequently Asked Questions
 
+### How should I acknowledge the VAST pipeline in my work?
+
+Please cite the Zenodo release: [10.5281/zenodo.13927015](https://doi.org/10.5281/zenodo.13927016).
+
 ### Can the VAST Pipeline be used with images from other telescopes?
 
 The base answer to this question is that the pipeline has been designed specifically for ASKAPsoft and ASKAPpipeline products, so compatibility with data from other telescopes is not supported.

docs/help_and_acknowledgements.md

@@ -4,27 +4,36 @@
 
 The best way to get help with the VAST Pipeline software is to contact the development team on GitHub. If you have encountered a specific problem while using the pipeline or attempting to install any of the components, please open a [new issue](https://github.com/askap-vast/vast-pipeline/issues/new). If you have a more general question or an idea for a new feature, please create a [new discussion thread](https://github.com/askap-vast/vast-pipeline/discussions/new).
 
-General enquiries may also be sent via email to the VAST project Principal Investigators:
+General enquiries about VAST may also be sent via email to the VAST project Principal Investigators:
 
 * [Tara Murphy](mailto:[email protected])
 * [David Kaplan](mailto:[email protected])
 
 ## Contributors
 
-* Sergio Pintaldi – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
+### Active
+
+* Dougal Dobie – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/) and [OzGrav](https://www.ozgrav.org)
+* Tom Mauch – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
 * Adam Stewart – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/)
+
+### Former
+
+* Sergio Pintaldi – [Sydney Informatics Hub](https://informatics.sydney.edu.au)
 * Andrew O'Brien – [Department of Physics, University of Wisconsin-Milwaukee](https://uwm.edu/physics/research/astronomy-gravitation-cosmology/)
 * Tara Murphy – [Sydney Institute for Astronomy](https://sifa.sydney.edu.au/)
 * David Kaplan – [Department of Physics, University of Wisconsin-Milwaukee](https://uwm.edu/physics/research/astronomy-gravitation-cosmology/)
-* Shibli Saleheen – [ADACS](https://adacs.org.au/who-we-are/our-team/)
-* David Liptai – [ADACS](https://adacs.org.au/who-we-are/our-team/)
-* Ella Xi Wang – [ADACS](https://adacs.org.au/who-we-are/our-team/)
+* Shibli Saleheen – [ADACS](https://adacs.org.au/)
+* David Liptai – [ADACS](https://adacs.org.au/)
+* Ella Xi Wang – [ADACS](https://adacs.org.au/)
+
 
 ## Acknowledgements
 
 The VAST Pipeline development was supported by:
 
 * The Australian Research Council through grants FT150100099 and DP190100561.
+* The Australian Research Council Centre of Excellence for Gravitational Wave Discovery (OzGrav), project numbers CE170100004 and CE230100016.
 * The Sydney Informatics Hub (SIH), a core research facility at the University of Sydney.
 * Software support resources awarded under the Astronomy Data and Computing Services (ADACS) Merit Allocation Program. ADACS is funded from the Astronomy National Collaborative Research Infrastructure Strategy (NCRIS) allocation provided by the Australian Government and managed by Astronomy Australia Limited (AAL).
 * NSF grant AST-1816492.

docs/theme/main.html

@@ -35,9 +35,7 @@
   </style>
 
   <a href="{{ base_url }}/changelog/">
-    <strong>
-     <strong> New in version 1.1.0:</strong>  Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the <strong>release notes!
-    </strong>
+     <strong> New in version 1.1.1:</strong> Refreshed docs, support for compressed fits files, python 3.10 and more 🧑‍💻. Check the <strong>release notes!</strong>
   </a>
 
 {% endblock %}

mkdocs.yml

@@ -4,7 +4,7 @@ site_description: >-
   extracted from the ASKAP telescope for radio transient detection science
 site_author: VAST Development Team
 site_url: https://vast-survey.org/vast-pipeline/
-copyright: Copyright © 2020 - 2025 Vast Development Team, University of Sydney - all right reserved
+copyright: Copyright © 2020 - 2025 VAST Pipeline Development Team, University of Sydney - all rights reserved. 
 
 repo_url: https://github.com/askap-vast/vast-pipeline
 repo_name: askap-vast/vast-pipeline
@@ -18,6 +18,7 @@ theme:
   name: material
   favicon: img/favicon.png
   logo: img/vast-logo.png
+  font: false
   features:
     - navigation.instant
     - navigation.tabs
@@ -211,6 +212,8 @@ plugins:
 
 extra:
   social:
+    - icon: simple/doi
+      link: https://doi.org/10.5281/zenodo.13927016
     - icon: fontawesome/brands/github
       link: https://github.com/askap-vast/vast-pipeline
       name: vast-pipeline source on GitHub

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vast-pipeline",
-  "version": "1.1.0d",
+  "version": "1.1.1",
   "description": "Vast Pipeline code base for processing and analysing telescope images from the Square Kilometre Pathfinder",
   "main": "gulpfile.js",
   "scripts": {

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vast-pipeline"
-version = "1.1.0"
+version = "v1.1.1"
 description = "Vast Pipeline code base for processing and analysing telescope images from the Square Kilometre Pathfinder"
 authors = ["The VAST Development Team"]
 license = "MIT"

vast_pipeline/_version.py

@@ -1 +1 @@
-__version__ = '1.1.0'
+__version__ = '1.1.1'