From aabdad34c2630513eb747fb57dd387194c02204f Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 12:54:07 -0400 Subject: [PATCH 1/8] DOC: release notes for v0.7.1 --- .github/workflows/docs.yml | 2 +- docs/source/release-history.rst | 44 +++++++++++++++++++++++++++++++++ requirements-dev.txt | 2 +- 3 files changed, 46 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6e29631..f74514e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ["3.9"] + python-version: ["3.10"] fail-fast: false defaults: diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index 92761f5..cd85e67 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -2,9 +2,53 @@ Release History =============== +v0.7.1 (2023-08-18) +------------------- + +API +... + +- Enabled generation beamline elements from existing simulations. +- Moved and updated the ``prepare_*_env.py`` code from the ``examples/`` + directory of the repository to the library code, so that the new module can be + imported in IPython and Jupyter notebooks (both interactively and in the docs). + The argparser CLI args parser was added to the module so that users can + specify the databroker config name and root path for the data files. + +Maintenance +........... + + +Documentation +............. + +- Pinned Sphinx to version 7.2.2+ to make it more compatible with the ``furo`` + theme. + +Tests +..... + +- Sorted out test failures happening due to a small numerical difference of the + results from the PyPI-installed ``srwpy`` in the Sirepo Docker. +- Removed an old/irrelevant test. + +CI improvements +............... + +- Switched from the conda action to built-in Python for CI (saves >2 minutes per + run). + + v0.7.0 (2023-08-04) ------------------- +This is a major release with new features to support the ``stateless-compute`` +API and propagation parameters in Sirepo/SRW and the old API used prior to +v0.4.0 removed. + +This release includes many useful contributions from the SULI 2023 summer intern +Riley Bode. Thank you! + New features ............ - Created ``.json`` and ``.yaml`` CLI exporters and added relevant tests. diff --git a/requirements-dev.txt b/requirements-dev.txt index 89130c8..d98c935 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -16,6 +16,6 @@ matplotlib nbsphinx numpydoc pandoc -sphinx==7.1.2 +sphinx>=7.2.2 sphinx-copybutton tabulate>=0.9.0 From 45fb23b3802bb0ace3ea7beca62826c16f20d4c6 Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:01:27 -0400 Subject: [PATCH 2/8] DOC: added summary for v0.7.1 before details --- docs/source/release-history.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index cd85e67..0e7e792 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -5,6 +5,8 @@ Release History v0.7.1 (2023-08-18) ------------------- +This is a maintenance release with small API, tests, CI, and documentation updates. + API ... @@ -15,10 +17,6 @@ API The argparser CLI args parser was added to the module so that users can specify the databroker config name and root path for the data files. -Maintenance -........... - - Documentation ............. From 33772a992cf1ead999fa7477e34cf0c0ce898d4e Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:02:29 -0400 Subject: [PATCH 3/8] DOC: minor text correction in rel-notes --- docs/source/release-history.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index 0e7e792..4a43556 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -10,7 +10,7 @@ This is a maintenance release with small API, tests, CI, and documentation updat API ... -- Enabled generation beamline elements from existing simulations. +- Enabled generation of beamline elements from existing simulations. - Moved and updated the ``prepare_*_env.py`` code from the ``examples/`` directory of the repository to the library code, so that the new module can be imported in IPython and Jupyter notebooks (both interactively and in the docs). From e6eb96ecef1a65b0c4198efa7866159c611ae66c Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:03:51 -0400 Subject: [PATCH 4/8] DOC: another minor text correction in rel-notes --- docs/source/release-history.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index 4a43556..9cf12a5 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -14,7 +14,7 @@ API - Moved and updated the ``prepare_*_env.py`` code from the ``examples/`` directory of the repository to the library code, so that the new module can be imported in IPython and Jupyter notebooks (both interactively and in the docs). - The argparser CLI args parser was added to the module so that users can + The ``argparser`` CLI argument parser was added to the module so that users can specify the databroker config name and root path for the data files. Documentation From fc8fac96e527715c1c938da40ad593a7d666c590 Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:05:00 -0400 Subject: [PATCH 5/8] DOC: another minor text correction in rel-notes --- docs/source/release-history.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index 9cf12a5..5a3b50b 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -27,7 +27,7 @@ Tests ..... - Sorted out test failures happening due to a small numerical difference of the - results from the PyPI-installed ``srwpy`` in the Sirepo Docker. + results from the PyPI-installed ``srwpy`` in the Sirepo Docker image. - Removed an old/irrelevant test. CI improvements From 70d78b8b1b146d5d8c837d8a6ae10556ffbbc822 Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:15:59 -0400 Subject: [PATCH 6/8] DOC: fix compatibility with sphinx via `furo` version pinning instead --- docs/source/release-history.rst | 4 ++-- requirements-dev.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index 5a3b50b..e719a8a 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -20,8 +20,8 @@ API Documentation ............. -- Pinned Sphinx to version 7.2.2+ to make it more compatible with the ``furo`` - theme. +- Pinned ``furo`` minimum version to 2023.8.17 to compatiblity with Sphinx 7.2.0 + and 7.2.1. Tests ..... diff --git a/requirements-dev.txt b/requirements-dev.txt index d98c935..667eb4a 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -9,13 +9,13 @@ pytest vcrpy>=4.3.1 # These are dependencies of various sphinx extensions for documentation. # cloud-sptheme -furo +furo>=2023.8.17 ipython jupyter matplotlib nbsphinx numpydoc pandoc -sphinx>=7.2.2 +sphinx sphinx-copybutton tabulate>=0.9.0 From 884950bf7f19f0eac581ef065f6378777dec1e40 Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:21:33 -0400 Subject: [PATCH 7/8] STY: autoupdate pre-commit configuration --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c506033..dabf179 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/ambv/black - rev: 23.3.0 + rev: 23.7.0 hooks: - id: black language_version: python3.10 @@ -17,7 +17,7 @@ repos: exclude: ^(.*\.py) args: [--line-length=88] - repo: https://github.com/pycqa/flake8 - rev: 6.0.0 + rev: 6.1.0 hooks: - id: flake8 - repo: https://github.com/pycqa/isort From fa4f62841e7e8effd80a5af370735364d294008f Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Fri, 18 Aug 2023 13:36:04 -0400 Subject: [PATCH 8/8] DOC: another minor text correction in rel-notes --- docs/source/release-history.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst index e719a8a..2bda6a4 100644 --- a/docs/source/release-history.rst +++ b/docs/source/release-history.rst @@ -20,7 +20,7 @@ API Documentation ............. -- Pinned ``furo`` minimum version to 2023.8.17 to compatiblity with Sphinx 7.2.0 +- Pinned ``furo`` minimum version to 2023.8.17 for compatiblity with Sphinx 7.2.0 and 7.2.1. Tests