Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and fix bold text #766

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ 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

- 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


Expand Down
4 changes: 4 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
19 changes: 14 additions & 5 deletions docs/help_and_acknowledgements.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 1 addition & 3 deletions docs/theme/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.0:</strong> Support for compressed fits files, python 3.10 and more 🧑‍💻. Check the <strong>release notes!</strong>
</a>

{% endblock %}
Expand Down
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 &copy; 2020 - 2025 Vast Development Team, University of Sydney - all right reserved
copyright: Copyright &copy; 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
Expand All @@ -18,6 +18,7 @@ theme:
name: material
favicon: img/favicon.png
logo: img/vast-logo.png
font: false
features:
- navigation.instant
- navigation.tabs
Expand Down Expand Up @@ -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
Expand Down
Loading