From eb31a100934fa7fb4580c71eef42c2100218e961 Mon Sep 17 00:00:00 2001 From: Andrew Shao Date: Thu, 14 May 2026 16:56:56 -0700 Subject: [PATCH] Add sunset notice to docs --- doc/changelog.md | 10 +++++++--- doc/index.rst | 1 + doc/overview.rst | 3 +++ doc/sunset_notice.rst | 19 +++++++++++++++++++ 4 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 doc/sunset_notice.rst diff --git a/doc/changelog.md b/doc/changelog.md index de4623ec5..b0265b194 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -11,6 +11,7 @@ To be released at some point in the future Description +- Add sunset notice to the documentation - Miscellaneous test fixes - Update install patch for PyTorch 2.7.1+rocm6.3 - Modernize typing syntax to Python 3.10+ standards @@ -28,9 +29,12 @@ Description Detailed Notes -- Enable control over monitoring of Models launched with `experiment.start()` by - adding an optional boolean argument determining whether to monitor the particular - model or not. The argument is set to True by default, so no changes are needed for +- Adds a sunset page to the documentation and a warning banner on the main + page noting the move to ROSE/RHAPSODY + ([SmartSim-PR804](https://github.com/CrayLabs/SmartSim/pull/804)) +- Enable control over monitoring of Models launched with `experiment.start()` by + adding an optional boolean argument determining whether to monitor the particular + model or not. The argument is set to True by default, so no changes are needed for the default behavior of monitoring all Models launched. ([SmartSim-PR788](https://github.com/CrayLabs/SmartSim/pull/788)) - Updated tests which would create experiment in root directory, patched diff --git a/doc/index.rst b/doc/index.rst index e6f6f0c3b..e593a9c06 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,6 +11,7 @@ :caption: Getting Started overview + sunset_notice installation_instructions/basic installation_instructions/platform contributing diff --git a/doc/overview.rst b/doc/overview.rst index 4bb921fd8..7f0584765 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -1,4 +1,7 @@ +.. warning:: + SmartSim is being sunset as of May 2026. Please see the :ref:`sunset notice page <_sunset_notice_doc>` + for more information. Thank you to all of our collaborators! ************ Introduction diff --git a/doc/sunset_notice.rst b/doc/sunset_notice.rst new file mode 100644 index 000000000..09f133178 --- /dev/null +++ b/doc/sunset_notice.rst @@ -0,0 +1,19 @@ +.. _sunset_notice_doc: + +################# +Sunsetting Notice +################# + +This release of SmartSim in May 2026 will be the final one as many of the ideas explored here +will be continued on in the `RHAPSODY `_ and its +related project `ROSE `_ + +The SmartSim project started back in 2019 to address the need of combining AI and scientific +simultion on high-performance computing platforms. We have had a number +of collaborators explore methods for using regression modelling for sub-grid scale parameterizations, +reinforcement learning for flow control, and AI/ML-assisted experimental design. We very much appreciate +all of our collaborators for letting us join them in their research especially. + +We will continue to keep this repository available for approximately another year. While we have +contacted most of the active users, if you need help porting over your applications to +ROSE/RHAPSODY contact the team: smartsim at hpe dot com. \ No newline at end of file