Release v3.1.1

CHANGELOG.md

@@ -4,6 +4,32 @@ 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 individal updates. This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.1](https://github.com/askap-vast/vast-tools/releases/v3.1.1) (2024-07-30)
+
+#### Added
+
+- Added 2023 workshop notebook to docs [#552](https://github.com/askap-vast/vast-tools/pull/552)
+
+#### Changed
+
+- Updated author email addresses [#553](https://github.com/askap-vast/vast-tools/pull/553)
+- Explicitly require setuptools in pyproject.toml [#553](https://github.com/askap-vast/vast-tools/pull/553)
+- Pin mkdocs=1.3.1 [#553](https://github.com/askap-vast/vast-tools/pull/553)
+- Force jinja2==3.0.3 [#551](https://github.com/askap-vast/vast-tools/pull/551)
+
+#### Fixed
+
+- Temporary fix for pydantic version breaking vaex [#553](https://github.com/askap-vast/vast-tools/pull/553)
+- Downgraded jinja2 to fix bug in docs deployment [#551](https://github.com/askap-vast/vast-tools/pull/551)
+
+#### Removed
+
+#### List of PRs
+
+- [#553](https://github.com/askap-vast/vast-tools/pull/553): fix, dep: Pin versions to fix dependency issues, update author email addresses
+- [#551](https://github.com/askap-vast/vast-tools/pull/551): fix, dep: Downgrade jinja2 to fix bug in docs deployment
+- [#552](https://github.com/askap-vast/vast-tools/pull/552): feat: Add 2023 workshop notebook to docs
+
 ## [3.1.0](https://github.com/askap-vast/vast-tools/releases/v3.1.0) (2024-07-26)
 
 #### Added

docs/notebook-examples/notebooks-overview.md

@@ -24,11 +24,14 @@ The available notebooks are:
 * [VAST Pipeline Exploration](vast-pipeline-example.ipynb)  
     Provides an example of how to interact with a run from the VAST Pipeline.
 
+* [VAST Workshop 2023 notebook](workshop-notebook-2023.ipynb)  
+    This notebook was used in the VAST software tutorial at the 2023 VAST Workshops. It provides an overview of the most common use cases, synthesising aspects of most of the above notebooks.
+
 !!! warning "Warning: Example Parameters"
     Remember that while the parameters and thresholds used in the example notebooks may provide a good starting point, they may not be best suited to your own science goals.
 
 ## Reporting Issues or Requesting a New Example
 
 To report an issue with a notebook please open an issue on the GitHub repository [here](https://github.com/askap-vast/vast-tools/issues){:target="_blank"}.
 
-To request that a new example be included in the notebooks please open a discussion on the GitHub repository [here](https://github.com/askap-vast/vast-tools/discussions){:target="_blank"}.
+To request that a new example be included in the notebooks please open a discussion on the GitHub repository [here](https://github.com/askap-vast/vast-tools/discussions){:target="_blank"}.

docs/notebook-examples/workshop-notebook-2023.ipynb

@@ -0,0 +1 @@
+../../notebook-examples/workshop-notebook-2023.ipynb

docs/theme/main.html

@@ -34,7 +34,7 @@
       strong{white-space:nowrap}.md-announce}
   </style>
 
-  <a href='{{ base_url }}/changelog/'><strong>Version 3.0.1 released!</strong> Includes access to all pilot survey data, full survey functionality, optimisation and more 🙌 Check the <strong>release notes! 👀</strong></a>
+  <a href='{{ base_url }}/changelog/'><strong>Version 3.1.1 released!</strong> Includes access to post-processed data, various bug fixes and more 🙌 Check the <strong>release notes! 👀</strong></a>
 
 {% endblock %}
 

mkdocs.yml

@@ -90,6 +90,7 @@ nav:
     - Query Source Search: notebook-examples/source-search-example.ipynb
     - Using VAST MOCs: notebook-examples/using-vast-mocs-example.ipynb
     - VAST Pipeline Exploration: notebook-examples/vast-pipeline-example.ipynb
+    - VAST Workshop 2023: notebook-examples/workshop-notebook-2023.ipynb
   - Contributing & Developing:
     - Developing VAST Tools: contributing/develop.md
     - GitHub Platform: contributing/github.md

pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "vasttools"
-version = "3.1.0"
+version = "v3.1.0-dev"
 description = "Python module to interact with ASKAP VAST data."
 license = "MIT"
 homepage = "https://github.com/askap-vast/vasttools/"
-authors = ["Adam Stewart <[email protected]>", "Dougal Dobie <ddobie@swin.edu.au>"]
+authors = ["Adam Stewart <[email protected]>", "Dougal Dobie <d.dobie@sydney.edu.au>"]
 include = ["vasttools/data", "example_notebooks"]
 
 [tool.poetry.dependencies]
@@ -16,7 +16,7 @@ colorcet = "^2.0.2"
 colorlog = "^4.1.0"
 dask = {extras = ["dataframe"], version = "^2021.10.0"}
 forced-phot = { git = "https://github.com/askap-vast/forced_phot.git" }
-matplotlib = "^3.2.1"
+matplotlib = ">=3.2.1 <3.7"
 mocpy = "^0.8.4"
 multiprocessing-logging = "^0.3.1"
 numexpr = "^2.7.1"
@@ -32,12 +32,15 @@ vaex-core = "^4.5.0"
 vaex-hdf5 = "^0.7.0"
 healpy = "^1.15.0"
 svgpath2mpl = "^1.0.0"
+setuptools = "^70.0.0"
+pydantic = "<2.0.0"
 
 [tool.poetry.dev-dependencies]
 ipdb = "^0.13.6"
 jupyterlab = "^3.6.7"
 jupyterlab-execute-time = "^2.0.2"
 jupyterlab-system-monitor = "^0.8.0"
+mkdocs = "1.3.1"
 mkdocs-material = "^7.3.0"
 mkdocstrings = "^0.17.0"
 mkdocs-minify-plugin = "^0.4.1"
@@ -52,7 +55,7 @@ pytest-mock = "^3.6.1"
 autopep8 = "^1.5.7"
 pytest-cov = "^2.12.1"
 flake8 = "^4.0.1"
-jinja2 = "3.1.4"
+jinja2 = "3.0.3"
 
 [tool.poetry.scripts]
 build_lightcurves = "vasttools.bin.build_lightcurves:main"

vasttools/__init__.py

@@ -9,7 +9,7 @@
 '''
 
 __author__ = 'Dougal Dobie, Adam Stewart'
-__version__ = "3.1.0"
+__version__ = "3.1.1"
 
 
 RELEASED_EPOCHS = {