From 0913094256b7ef149b0ae19fda4f03bc329c5c9e Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 21:36:25 +1100 Subject: [PATCH 1/6] Remove errant --- docs/theme/main.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/theme/main.html b/docs/theme/main.html index 5ecf60ff..6d891fd3 100644 --- a/docs/theme/main.html +++ b/docs/theme/main.html @@ -35,9 +35,7 @@ - - New in version 1.1.0: Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the release notes! - + New in version 1.1.0: Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the release notes! {% endblock %} From b6fb0a9c0fb484b6b8a25960188b38cef6f54e5a Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 21:37:30 +1100 Subject: [PATCH 2/6] Remove extra space --- docs/theme/main.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/theme/main.html b/docs/theme/main.html index 6d891fd3..9a073ccc 100644 --- a/docs/theme/main.html +++ b/docs/theme/main.html @@ -35,7 +35,7 @@ - New in version 1.1.0: Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the release notes! + New in version 1.1.0: Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the release notes! {% endblock %} From b058393d326ae32d1c9cad262bfd5a7e9649d48e Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 21:38:38 +1100 Subject: [PATCH 3/6] Updated changelog --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 20a34aee..24518d2c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,10 +16,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), #### Fixed +- Removed errant 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 tag from docs header - [#761](https://github.com/askap-vast/vast-pipeline/pull/762): docs: Add Zenodo DOI From 8e99e56a2626dbbae7b9aeb251b66e801a5fb51e Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 21:55:27 +1100 Subject: [PATCH 4/6] Updated docs --- docs/faq.md | 4 ++++ docs/help_and_acknowledgements.md | 19 ++++++++++++++----- mkdocs.yml | 5 ++++- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 7075f468..b38bd743 100644 --- a/docs/faq.md +++ b/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. diff --git a/docs/help_and_acknowledgements.md b/docs/help_and_acknowledgements.md index e4298d92..4715dc17 100644 --- a/docs/help_and_acknowledgements.md +++ b/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:tara.murphy@sydney.edu.au) * [David Kaplan](mailto:kaplan@uwm.edu) ## 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. diff --git a/mkdocs.yml b/mkdocs.yml index 6ae38b6a..6072c77a 100644 --- a/mkdocs.yml +++ b/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 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 From 53b46d5e7cec5c0e491dce6d5a62161bc8a39a05 Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 21:58:26 +1100 Subject: [PATCH 5/6] More fixes --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 6072c77a..ca4f1d61 100644 --- a/mkdocs.yml +++ b/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 rights 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 From 97f01abe5ee2e2b493daaa773b7e4a03cf46fef3 Mon Sep 17 00:00:00 2001 From: Dougal Dobie Date: Mon, 14 Oct 2024 22:01:13 +1100 Subject: [PATCH 6/6] Updated changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 24518d2c..0810fb78 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), #### 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 @@ -22,7 +23,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), #### List of PRs -- [#766](https://github.com/askap-vast/vast-pipeline/pull/766): docs: Removed errant tag from docs header +- [#766](https://github.com/askap-vast/vast-pipeline/pull/766): docs: Removed errant tag from docs header and refreshed docs text - [#761](https://github.com/askap-vast/vast-pipeline/pull/762): docs: Add Zenodo DOI