docs updates for 0.8.0 release (#870)

* docs updates and script updates for 0.8.0 release

.uberenv_config.json

@@ -7,7 +7,7 @@
 "spack_packages_path": "scripts/uberenv_configs/packages",
 "spack_url": "https://github.com/alpine-DAV/spack",
 "mirror_url": "https://www.ascent-dav.org/mirror/ascent/latest/",
-"spack_branch": "ascent/develop",
+"spack_branch": "ascent/releases/v0.8.0",
 "spack_activate" : { "py-numpy"  : ["+python"],
                      "py-pip"    : ["+python"],
                      "py-mpi4py" : ["+python", "+mpi"],

CHANGELOG.md

@@ -4,10 +4,10 @@ Notable changes to Ascent are documented in this file. This changelog started on
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project aspires to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.8.0] - Released 2022-02-11
 
-### Preferred dependency versions for [email protected] (WIP)
-- [email protected].0
+### Preferred dependency versions for [email protected]
+- [email protected].2
 - [email protected]
 - [email protected]
 - [email protected]
@@ -21,12 +21,14 @@ and this project aspires to adhere to [Semantic Versioning](https://semver.org/s
 - Added `streamline` and `particle_advection` transforms 
 - Added history gradient expressions
 - Added the ability save named sessions
+- Added new options to specify Cinema rendering parameters
 - Added the ability save subsets of expression results to session files
 - Added the ability to add comments to PNG files that Ascent creates
 - Added timings out control option to Ascent (and Flow)
 - Added support to render Polygonal nd Polyhedral Meshes 
 - Added option to turn of world annotations
 - Added FIDES Support
+- Added Spack and Uberenv support for building on Perlmutter
 
 ### Fixed
 - Fixed a bug where ascent timings files were written out twice
@@ -40,7 +42,7 @@ and this project aspires to adhere to [Semantic Versioning](https://semver.org/s
 - Updated to use VTK-m 1.7.0
 - Make Ascent Webserver support optional, linked to if Conduit Relay Web support exists
 - Simplified the relay extract protocol params, for example can now use `hdf5` instead of `blueprint/mesh/hdf5`
-
+- Updated Spack and Uberenv support for building on Summit
 
 ## [0.7.1] - Released 2021-05-20
 

README.md

@@ -4,12 +4,27 @@ Ascent
 
 Ascent is an open source many-core capable lightweight in situ visualization and analysis infrastructure for multi-physics HPC simulations.
 
+
+Learn how to use Ascent with Docker + Jupyter
+==============================================
+
+If you have Docker, an easy way to learn about Ascent is to run our prebuilt Docker container:
+
+
+    docker run -p 8888:8888 -t -i alpinedav/ascent-jupyter
+
+
+Then open http://localhost:8888 in your browser to connect to the Jupyter Server in the container.
+The password for the Jupyter server is: **learn**.  From here, you can run Ascent's Python Tutorial Notebook examples. For more details see our https://ascent.readthedocs.io/en/latest/Tutorial.html.
+
+
 Documentation
 =================
 
 To get started building and using Ascent, check out the full documentation:
 
-https://alpine-dav.github.io/ascent/
+https://ascent.readthedocs.io/en/latest/
+
 
 Source Repo
 =================
@@ -18,6 +33,12 @@ Ascent's source is hosted on GitHub:
 
 https://github.com/Alpine-DAV/ascent
 
+
+Contributors
+=============
+https://github.com/Alpine-DAV/ascent/graphs/contributors
+
+
 License
 ===========
 
@@ -31,3 +52,5 @@ or the following files in the Ascent source tree:
 Changelog
 =========
 - [Changelog](/CHANGELOG.md)
+
+

scripts/gen_release_tarball.py

@@ -0,0 +1,33 @@
+# Copyright (c) Lawrence Livermore National Security, LLC and other Ascent
+# Project developers. See top-level LICENSE AND COPYRIGHT files for dates and
+# other details. No copyright assignment is required to contribute to Ascent.
+
+import subprocess
+import json
+from optparse import OptionParser
+
+def parse_args():
+    "Parses args from command line"
+    parser = OptionParser()
+    parser.add_option("--version",
+                      dest="ver",
+                      default=None,
+                      help="version string")
+    opts, extras = parser.parse_args()
+    # we want a dict b/c
+    opts = vars(opts)
+    return opts
+
+def shexe(cmd):
+    print("[shexe: {0}]".format(cmd))
+    subprocess.call(cmd,shell=True)
+
+def main():
+    opts = parse_args()
+    print(json.dumps(opts,indent=2))
+    shexe("scripts/git_archive_all.py --prefix ascent-v{0} ascent-v{0}-src-with-blt.tar.gz".format(opts["ver"]))
+    shexe("shasum -a 256 ascent-v{0}-src-with-blt.tar.gz".format(opts["ver"]))
+
+
+if __name__ == "__main__":
+    main()

scripts/gen_relnotes_variants_from_changelog.py

@@ -0,0 +1,138 @@
+# Copyright (c) Lawrence Livermore National Security, LLC and other Ascent
+# Project developers. See top-level LICENSE AND COPYRIGHT files for dates and
+# other details. No copyright assignment is required to contribute to Ascent.
+"""
+file: gen_relnotes_variants_from_changelog.py
+description:
+ Release helper -- converts change log entries into text for:
+  - the github release entry
+  - the sphinx docs release entry
+  - the release entry for the llnl open source news github url
+
+usage:
+  python gen_relnotes_variants_from_changelog.py Unreleased
+  python gen_relnotes_variants_from_changelog.py 0.5.1
+
+note:
+ assumes CHANGELOG.md is at ".."
+"""
+
+import os
+import sys
+import datetime
+
+def proc_changelog_rel_id_line(l):
+    active_rel = l.split()[1]
+    if active_rel.startswith("["):
+        active_rel =active_rel[1:-1]
+    return active_rel
+
+def timestamp(t=None,sep="_"):
+    """ Creates a timestamp that can easily be included in a filename. """
+    if t is None:
+        t = datetime.datetime.now()
+    #sargs = (t.year,t.month,t.day,t.hour,t.minute,t.second)
+    #sbase = "".join(["%04d",sep,"%02d",sep,"%02d",sep,"%02d",sep,"%02d",sep,"%02d"])
+    sargs = (t.year,t.month,t.day)
+    sbase = "".join(["%04d",sep,"%02d",sep,"%02d"])
+    return  sbase % sargs
+
+def ascent_blurb():
+    return "[Ascent](https://github.com/Alpine-DAV/ascent) is flyweight in situ visualization and analysis runtime for multi-physics HPC simulations"
+
+def gen_llnl_news_entry(release_id,src):
+    txt  = "---\n"
+    txt += 'title: "Ascent {0} Released"\n'.format(release_id)
+    txt += 'categories: release\n'
+    txt += "---\n\n"
+    txt += ascent_blurb()
+    txt += "\n"
+    txt += "\n\n"
+    txt += "Learn more:\n"
+    txt += "- [Release notes](https://github.com/Alpine-DAV/ascent/releases/tag/v{0})\n".format(release_id)
+    txt += "- [Documentation](http://ascent.readthedocs.io/)\n"
+    txt += "- [GitHub repo](https://github.com/Alpine-DAV/ascent)\n"
+    return txt
+
+def gen_sphinx_entry(release_id,src):
+    txt  = "v{0}\n".format(release_id)
+    txt += "---------------------------------\n\n"
+    txt += "* `Source Tarball <https://github.com/Alpine-DAV/ascent/releases/download/v{0}/ascent-v{0}-src-with-blt.tar.gz>`__\n\n".format(release_id)
+    txt += "* Docker Containers\n"
+    txt += "   * ``alpinedav/ascent:{0}``\n".format(release_id)
+    txt += "   * ``alpinedav/ascent-jupyter:{0}``\n\n".format(release_id)
+    txt += "Highlights\n"
+    txt += "++++++++++++++++++++++++++++++++++++\n\n"
+    txt += "(Extracted from Ascent's :download:`Changelog <../../../CHANGELOG.md>`)\n\n"
+    sub_open = False
+    active_rel = ""
+    for l in src.split("\n"):
+        if l.startswith("## "):
+            sub_open = False
+            active_rel = proc_changelog_rel_id_line(l)
+            #print(active_rel)
+            #print("BEGIN RELEASE {0}",l)
+        elif l.startswith("### ") and active_rel == release_id:
+            sub_open = True
+            sub_title = l[3:].strip()
+            txt += "\n"+ sub_title +"\n"
+            txt += "~" * len(sub_title) + "\n\n"
+        elif l.startswith("#### ") and active_rel == release_id:
+            sub_open = True
+            sub_title = l[4:].strip()
+            txt += "\n* **" + sub_title +"**\n\n"
+        elif sub_open and active_rel == release_id and l.startswith("-"):
+            txt += " * " + sphinx_translate_ticks(l[1:].strip())+"\n"
+    return txt
+
+def sphinx_translate_ticks(l):
+    # todo, we may need to do a more robust job of this ..
+    return l.replace("`","``")
+
+def gen_github_entry(release_id,src):
+    txt  = "# {0} Release Highlights\n\n".format(release_id)
+    txt += "(adapted from Ascent's [Changelog](https://github.com/Alpine-DAV/ascent/blob/develop/CHANGELOG.md)\n"
+    sub_open = False
+    active_rel = ""
+    for l in src.split("\n"):
+        if l.startswith("## "):
+            sub_open = False
+            active_rel = proc_changelog_rel_id_line(l)
+            #print(active_rel)
+            #print("BEGIN RELEASE {0}",l)
+        elif l.startswith("### ") and active_rel == release_id:
+            sub_open = True
+            txt += l +"\n"
+            print("BEGIN SUB {0}",l)
+        elif sub_open and active_rel == release_id:
+            txt += l +"\n"
+    txt += "## Docker Containers\n"
+    txt += " - **alpinedav/ascent:{0}**\n".format(release_id)
+    txt += " - **alpinedav/ascent-jupyter:{0}**\n".format(release_id)
+    return txt
+
+def main():
+    release_id = "Unreleased"
+    if len(sys.argv) > 1:
+        release_id = sys.argv[1]
+    src = open("../CHANGELOG.md").read()
+    print("----GITHUB_ENTRY----BEG----")
+    print(gen_github_entry(release_id,src))
+    print("----GITHUB_ENTRY----END----")
+    print("")
+    print("----SPHINX_ENTRY----BEG----")
+    print(gen_sphinx_entry(release_id,src))
+    print("----SPHINX_ENTRY----END----")
+    print("")
+    print("----LLNLNEWS_ENTRY----BEG----")
+    ntxt = gen_llnl_news_entry(release_id,src)
+    print(ntxt)
+    print("----LLNLNEWS_ENTRY----END----")
+    nfile = timestamp(sep="-") + "-ascent.md"
+    print("[saving llnl news entry to: {0}]".format(nfile))
+    open(nfile,"w").write(ntxt)
+
+
+if __name__ == "__main__":
+    main()
+

src/CMakeLists.txt

@@ -11,7 +11,7 @@ cmake_policy(SET CMP0048 NEW)
 # Ascent
 ################################
 
-project(ascent VERSION "0.7.1")
+project(ascent VERSION "0.8.0")
 
 ################################
 # Build Options