Merge pull request #96 from mrakitin/doc-rel-notes-v0.5.0

DOC: release notes for v0.5.0

.github/CODEOWNERS

@@ -1 +1 @@
-* @AbbyGi @jennmald @jklynch @mrakitin
+* @AbbyGi @jklynch @mrakitin @thomaswmorris

.github/workflows/publish-docs.yml

@@ -3,7 +3,7 @@ name: Publish documentation
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   publish_docs:
@@ -100,9 +100,9 @@ jobs:
         uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
         with:
           deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
-          publish_branch: master
-          publish_dir: ./docs/build/html
           external_repository: NSLS-II/NSLS-II.github.io
+          publish_branch: master  # branch in the external repository
+          publish_dir: ./docs/build/html
           destination_dir: ${{ env.REPOSITORY_NAME }}  # just the repo name, without the "NSLS-II/"
           keep_files: true  # Keep old files.
           force_orphan: false  # Keep git history.

.github/workflows/testing.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10"]
         docker-binary: ["docker", "podman"]
       fail-fast: false
 

docs/build-table.py

@@ -16,7 +16,7 @@ def find_predefined_examples(
     verbose=False,
 ):
 
-    base_url = "https://github.com/NSLS-II/sirepo-bluesky/tree/master/"
+    base_url = "https://github.com/NSLS-II/sirepo-bluesky/tree/main/"
 
     pattern_file = f"{pattern}/sirepo-data.json"
     sim_jsons = sorted(glob.glob(os.path.join(path, sim_type, pattern_file)))

docs/source/installation.rst

@@ -62,7 +62,7 @@ Configuration of databroker
 To to access the collected data with the `databroker
 <https://blueskyproject.io/databroker>`_ library, we need to configure it. For
 that, please copy the `local.yml
-<https://github.com/NSLS-II/sirepo-bluesky/blob/master/examples/local.yml>`_
+<https://github.com/NSLS-II/sirepo-bluesky/blob/main/examples/local.yml>`_
 configuration file to the ``~/.config/databroker/`` directory.
 
 .. include:: ../../examples/local.yml

docs/source/release-history.rst

@@ -2,6 +2,62 @@
 Release History
 ===============
 
+v0.5.0 (2022-11-04)
+-------------------
+This is a major release dropping support of Python 3.7 and adding support of
+new simulation types.
+
+Applications
+............
+- Added support for the MAD-X App in Sirepo via detector & flyer API.
+  Corresponding simulation examples were added too (sim_id=00000001 and
+  00000002). The corresponding handler ``MADXFileHandler`` was implemented for
+  reading of MAD-X produced files.
+- Implemented ``SingleElectronSpectrumReport`` from the Source page of
+  Sirepo/SRW.
+- Added the ``duration`` component for detectors.
+- Implemented the ``stateless-compute`` support for the grazing angle
+  orientation. That is necessary to support recalculation of some properties
+  which are normally triggered by the JavaScript client side.
+- Converted assertions to exceptions throughout the library code.
+
+Tests
+.....
+- All integrated simulation codes have corresponging extensive tests (`pytest
+  <https://docs.pytest.org/>`_ framework).
+
+Examples
+........
+- Updated the preparation scripts for the detector and flyer environments to
+  make them more consistent.
+- Save all test/example data to ``/tmp/sirepo-bluesky-data/``.
+
+Documentation
+.............
+- Made all examples for SRW, Shadow3, and Beam Statistics Report consistent.
+- Added a documentation/notebook with an example of the use of MAD-X via
+  sirepo-bluesky API.
+- Changed the Sphinx theme to `Cloud <https://cloud-sptheme.readthedocs.io>`_.
+- Consitent table widths for simulation lists for different simulation codes.
+- Fixed the version string in the published documentation at
+  nsls-ii.github.io/sirepo-bluesky.
+
+Scripts/services
+................
+- Added support for persistent location for the Sirepo database of simulations.
+- Using the ``radiasoft/sirepo:20220806.215448`` version of the Sirepo Docker
+  image (support of newer images will be added in the following release).
+- Added an example systemd unit for ``sirepo.service``.
+
+CI improvements
+...............
+- Added checks whether the Sirepo container is running before executing the
+  tests.
+- Using ``mamba`` for faster installation.
+- Uploading docs artifacts for each CI run (to allow inspection of the
+  documentation draft before publishing it).
+
+
 v0.4.3 (2021-12-17)
 -------------------
 - Major rework of the Sphinx documentation with a few automatically rendered
@@ -33,8 +89,8 @@ In this release, we addressed some shortcomings of the granular ophyd objects:
 - Cleaned up the code from unused comments.
 - Improved testing coverage and better handling of the results directories.
 
-Packaging/CI:
-...............
+Packaging/CI
+............
 - Removed the upper pin of PyQt5.
 - Added linting GHA workflow.
 

setup.py

@@ -7,7 +7,7 @@
 # NOTE: This file must remain Python 2 compatible for the foreseeable future,
 # to ensure that we error out properly for people with outdated setuptools
 # and/or pip.
-min_version = (3, 6)
+min_version = (3, 8)
 if sys.version_info < min_version:
     error = """
 sirepo-bluesky does not support Python {0}.{1}.
@@ -40,7 +40,7 @@
     description="Sirepo-Bluesky interface",
     long_description=readme,
     author="Brookhaven National Laboratory",
-    author_email='DAMA@bnl.gov',
+    author_email='mrakitin@bnl.gov',
     url='https://github.com/NSLS-II/sirepo-bluesky',
     python_requires='>={}'.format('.'.join(str(n) for n in min_version)),
     packages=find_packages(exclude=['docs', 'tests']),