Merge pull request tardis-sn#7 from tardis-sn/continuum_process_updat…

…ed_from_master

merge of upstream

azure-pipelines/release-version.yml → .azure-pipelines/release-version.yml

@@ -39,17 +39,17 @@ jobs:
       - bash: |
           cd $(tardis.dir)
           source activate tardis
-          echo $(python -c 'from setuptools_scm import version_from_scm; from setuptools_scm.version import guess_next_date_ver; release = version_from_scm("."); print(release.tag.public)')
-        displayName: 'Check latest TARDIS tag'
+          echo $(python .ci-helpers/get_current_version.py)
+        displayName: 'Check latest tag'
 
       - bash: |
           cd $(tardis.dir)
           source activate tardis
-          echo "##vso[task.setvariable variable=newtag]$(python -c 'from setuptools_scm import version_from_scm; from setuptools_scm.version import guess_next_date_ver; release = version_from_scm("."); print(guess_next_date_ver(release.tag.public))')"
-        displayName: 'Get new TARDIS tag'
+          echo "##vso[task.setvariable variable=newtag]$(python .ci-helpers/get_next_version.py)"
+        displayName: 'Get new tag'
 
       - bash: echo $(newtag)
-        displayName: 'Check new TARDIS tag'
+        displayName: 'Check new tag'
 
       - task: GitHubRelease@1
         inputs:
@@ -60,8 +60,7 @@ jobs:
           tagSource: 'userSpecifiedTag'
           tag: 'release-$(newtag)'
           title: 'TARDIS v$(newtag)'
-          isPreRelease: false
-          addChangeLog: true
-          changeLogCompareToRelease: 'lastFullRelease'
-          changeLogType: 'commitBased'
+          releaseNotesSource: 'inline'
+          releaseNotes: 'This release has been made automatically through our continous delivery pipeline. For a complete list of changes see [CHANGELOG.md](https://github.com/tardis-sn/tardis/blob/master/CHANGELOG.md).'
+          addChangeLog: false
         displayName: 'Create GitHub Release'

.ci-helpers/get_current_version.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+
+import sys
+from setuptools_scm import version_from_scm
+from setuptools_scm.version import guess_next_date_ver
+
+version = version_from_scm(".").tag.public
+
+print(version)
+sys.exit(0)

.ci-helpers/get_next_version.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+
+import sys
+from setuptools_scm import version_from_scm
+from setuptools_scm.version import guess_next_date_ver
+
+version = version_from_scm(".").tag.public
+version = guess_next_date_ver(version)
+version = version.rstrip(".0") if version.endswith(".0") else version
+
+print(version)
+sys.exit(0)

.github/workflows/documentation-build.yml

@@ -8,9 +8,6 @@ on:
     branches:
     - master
 
-  schedule:
-    - cron: '10 0 * * 0'
-
   workflow_dispatch:  # Manual trigger
 
 jobs:

.github/workflows/update-changelog.yml

@@ -4,15 +4,15 @@
 name: update-changelog
 
 on:
-  schedule:
-    - cron: '50 23 * * 0'
+  push:
+    tags:
+    - 'release-*'
 
-  workflow_dispatch:
+  workflow_dispatch:  # Manual trigger
 
 jobs:
   push:
     runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'tardis-sn' }}  # Do not run scheduled jobs on forks
 
     steps:
       - uses: actions/checkout@v2
@@ -34,5 +34,5 @@ jobs:
       - name: Push changes
         run: |
           git add CHANGELOG.md
-          git commit -m "Update CHANGELOG.md [skip ci]"
+          git commit -m "Post-release updates [auto]"
           git push

.github/workflows/update-zenodo-json.yml

@@ -31,7 +31,7 @@ jobs:
           python-version: 3.6
 
       - name: Install Packages
-        run: pip install pandas==1.0.5 jupyter nbconvert==5.3.1 tornado==4.2 orcid
+        run: pip install pandas==1.0.5 jupyter==1.0.0 jupyter-client==6.1.2 nbconvert==5.3.1 tornado==4.2 orcid
 
       - name: Run Notebook
         run: jupyter nbconvert gather_data.ipynb --to html --execute --ExecutePreprocessor.timeout=6000
@@ -82,7 +82,7 @@ jobs:
              exit 0
 
           else
-            git commit -m "Update zenodo.json [skip ci]"
+            git commit -m "Update zenodo.json [auto] [skip ci]"
             git push
 
           fi

.zenodo.json

@@ -129,22 +129,22 @@
       "name": "O'Brien, Jack"
     },
     {
-      "name": "Reinecke, Martin"
+      "name": "Arya, Atharva"
     },
     {
       "name": "Eweis, Youssef"
     },
     {
-      "name": "Bylund, Tomas"
+      "name": "Reinecke, Martin"
     },
     {
-      "name": "Arya, Atharva"
+      "name": "Bylund, Tomas"
     },
     {
-      "name": "Savel, Arjun"
+      "name": "Bentil, Laud"
     },
     {
-      "name": "Bentil, Laud"
+      "name": "Savel, Arjun"
     },
     {
       "name": "Eguren, Jordi",
@@ -154,13 +154,13 @@
       "name": "Alam, Arib"
     },
     {
-      "name": "Magee, Mark"
+      "name": "Yu, Jenny"
     },
     {
-      "name": "Livneh, Ran"
+      "name": "Magee, Mark"
     },
     {
-      "name": "Yu, Jenny"
+      "name": "Livneh, Ran"
     },
     {
       "name": "Rajagopalan, Srinath"
@@ -185,64 +185,64 @@
       "name": "Singh, Sourav"
     },
     {
-      "name": "Selsing, Jonatan"
+      "name": "Sofiatti, Caroline"
     },
     {
       "name": "Talegaonkar, Chinmay"
     },
     {
-      "name": "Sofiatti, Caroline"
+      "name": "Kowalski, Nathan"
     },
     {
-      "name": "Kowalski, Nathan"
+      "name": "Selsing, Jonatan"
     },
     {
-      "name": "Patra, Nilesh"
+      "name": "Wahi, Ujjwal"
     },
     {
-      "name": "Gupta, Suyash"
+      "name": "Sandler, Morgan"
     },
     {
-      "name": "Aggarwal, Yash"
+      "name": "Sarafina, Nance"
     },
     {
-      "name": "Sandler, Morgan"
+      "name": "Patra, Nilesh"
     },
     {
-      "name": "Sarafina, Nance"
+      "name": "Singh Rathore, Parikshit"
     },
     {
-      "name": "Volodin, Dmitry"
+      "name": "Patel, Pratik"
     },
     {
-      "name": "Dasgupta, Debajyoti"
+      "name": "Sharma, Sampark"
     },
     {
-      "name": "Kolliboyina, Chaitanya"
+      "name": "Gupta, Suyash"
     },
     {
-      "name": "Wahi, Ujjwal"
+      "name": "Volodin, Dmitry"
     },
     {
-      "name": "Kumar, Atul"
+      "name": "Aggarwal, Yash"
     },
     {
-      "name": "Yap, Kevin"
+      "name": "Dasgupta, Debajyoti"
     },
     {
-      "name": "Singh Rathore, Parikshit"
+      "name": "Kolliboyina, Chaitanya"
     },
     {
-      "name": "Nayak U, Ashwin"
+      "name": "Yap, Kevin"
     },
     {
-      "name": "Patel, Pratik"
+      "name": "Nayak U, Ashwin"
     },
     {
       "name": "Kharkar, Atharwa"
     },
     {
-      "name": "Sharma, Sampark"
+      "name": "Kumar, Atul"
     }
   ]
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Change Log
 
+### release-2021.8.26 (2021/08/26 16:40 +00:00)
+- [#1789](https://github.com/tardis-sn/tardis/pull/1789) add explicit jupyter dependency (#1789) (@epassaro)
+- [#1787](https://github.com/tardis-sn/tardis/pull/1787) fix zenodo pipeline env (#1787) (@epassaro)
+- [#1786](https://github.com/tardis-sn/tardis/pull/1786) fix for release task (#1786) (@epassaro)
+- [#1703](https://github.com/tardis-sn/tardis/pull/1703) Adding Progress Bars (#1703) (@atharva-2001)
+- [#1775](https://github.com/tardis-sn/tardis/pull/1775) orchestrating continuous delivery pipeline (#1775) (@epassaro)
+- [#1778](https://github.com/tardis-sn/tardis/pull/1778) Fix hoverdata in plasma plots (#1778) (@atharva-2001)
+- [#1693](https://github.com/tardis-sn/tardis/pull/1693) Enabling virtual_packet_logging by default in the visualization folder (#1693) (@atharva-2001)
+
+### release-2021.8.15.0 (2021/08/12 14:24 +00:00)
+- [#1770](https://github.com/tardis-sn/tardis/pull/1770) Rename cplots to convergence_plots (#1770) (@atharva-2001)
+- [#1772](https://github.com/tardis-sn/tardis/pull/1772) Reverse legend in Plasma Convergence Plots (#1772) (@atharva-2001)
+
 ### release-2021.8.8.0 (2021/08/05 18:49 +00:00)
 - [#1768](https://github.com/tardis-sn/tardis/pull/1768) Renamed `specific` log flag to `specific_log_level`  (#1768) (@DhruvSondhi)
 - [#1721](https://github.com/tardis-sn/tardis/pull/1721) Restructure Model Configuration Documentation (#1721) (@smithis7)

docs/conf.py

@@ -326,6 +326,21 @@ def to_html_ext(path):
     return os.path.splitext(path)[0] + ".html"
 
 
+def generate_tutorials_page(app):
+    notebooks = ""
+
+    for root, dirs, fnames in os.walk("io/"):
+        for fname in fnames:
+            if fname.endswith(".ipynb") and "checkpoint" not in fname:
+                notebooks += f"\n* :doc:`{root}/{fname[:-6]}`"
+
+    title = "Tutorials\n*********\n"
+    description = "The following pages contain the TARDIS tutorials:"
+
+    with open("tutorials.rst", mode="wt", encoding="utf-8") as f:
+        f.write(f"{title}\n{description}\n{notebooks}")
+
+
 def autodoc_skip_member(app, what, name, obj, skip, options):
     """Exclude specific functions/methods from the documentation"""
     exclusions = ("yaml_constructors", "yaml_implicit_resolvers")
@@ -355,8 +370,8 @@ def create_redirect_files(app, docname):
             with open(old_html_fpath, "w") as f:
                 f.write(new_content)
 
-
 def setup(app):
+    app.connect("builder-inited", generate_tutorials_page)
     app.connect("autodoc-skip-member", autodoc_skip_member)
     app.connect("build-finished", create_redirect_files)
 

docs/index.rst

@@ -50,7 +50,8 @@ Mission Statement
 
     installation
     quickstart/quickstart
-
+    tutorials
+    API <api/modules>
 
 
 .. toctree::
@@ -104,14 +105,6 @@ Mission Statement
     CHANGELOG.md
     roadmap
 
-.. toctree::
-    :maxdepth: 2
-    :caption: API
-    :hidden:
-
-    api/modules
-
-
 
 .. toctree::
     :caption: References