Merge pull request #188 from weikang9009/release

Edits to changelog, README, and doc website for v2.3.4 release
pysal · Mar 12, 2023 · d8bb904 · d8bb904
2 parents c7c6589 + d9f6e20
commit d8bb904
Show file tree

Hide file tree

Showing 63 changed files with 192 additions and 149 deletions.
diff --git a/.github/workflows/release_and_publish.yml b/.github/workflows/release_and_publish.yml
@@ -36,25 +36,25 @@ jobs:
           python -m pip install --upgrade pip
           pip install setuptools wheel twine jupyter urllib3 pandas pyyaml
           python setup.py sdist bdist_wheel
-      - name: Run Changelog
-        run: |
-          jupyter nbconvert --to notebook --execute --inplace --ExecutePreprocessor.timeout=-1 --ExecutePreprocessor.kernel_name=python3 tools/gitcount.ipynb
-      - name: Cat Changelog
-        uses: pCYSl5EDgo/cat@master
-        id: changetxt
-        with:
-          path: ./tools/changelog.md
-        env:
-          TEXT: ${{ steps.changetxt.outputs.text }}
-      - name: Create Release Notes
-        uses: actions/github-script@v6
-        with:
-          github-token: ${{secrets.GITHUB_TOKEN}}
-          script: |
-            await github.request(`POST /repos/${{ github.repository }}/releases`, {
-              tag_name: "${{ github.ref }}",
-              generate_release_notes: true
-            });
+#      - name: Run Changelog
+#        run: |
+#          jupyter nbconvert --to notebook --execute --inplace --ExecutePreprocessor.timeout=-1 --ExecutePreprocessor.kernel_name=python3 tools/gitcount.ipynb
+#      - name: Cat Changelog
+#        uses: pCYSl5EDgo/cat@master
+#        id: changetxt
+#        with:
+#          path: ./tools/changelog.md
+#        env:
+#          TEXT: ${{ steps.changetxt.outputs.text }}
+#      - name: Create Release Notes
+#        uses: actions/github-script@v6
+#        with:
+#          github-token: ${{secrets.GITHUB_TOKEN}}
+#          script: |
+#            await github.request(`POST /repos/${{ github.repository }}/releases`, {
+#              tag_name: "${{ github.ref }}",
+#              generate_release_notes: true
+#            });
 #      - name: Create Release
 #        id: create_release
 #        uses: actions/create-release@v1

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,64 @@
+# Version 2.3.4 (2023-03-02)
+
+We closed a total of 49 issues (enhancements and bug fixes) through 20 pull requests, since our last release on 2020-06-10.
+
+## Issues Closed
+  - small edits to long description (#187)
+  - update github action for release (#186)
+  - Update bleeding edge `libpysal` in dev envs (#185)
+  - Prepare for v2.3.4 release (#182)
+  - Adjust and update docs  (#180)
+  - changing configuration for the testing action (#181)
+  - default esda branch master -> main (#178)
+  - CI needs redesign (#172)
+  - change master to main (#174)
+  - Main (#177)
+  - refactor: deprecate fmpt and replace with mfpt (#171)
+  - update dev branches; test shapely dev (#176)
+  - Spatial_Markov gives its own set of 'k' classes even though explicitly mentioned as paramter value (#175)
+  - CI update & redesign (#173)
+  - [WIP] Add test for Python 3.9 (#164)
+  - add custom codecov schema (#167)
+  - Update docs (#170)
+  - update pysal favicon (#169)
+  - update release_and_publish.yml (#166)
+  - removing unused docs materials (#168)
+  - (doc) remove unused requirements for doc building (#165)
+  - (docs) fix docs for spatial Markov (#163)
+  - (docs) remove redirection to readthedocs as the docs are now hosted on github page (#162)
+  - allow users to pass manually calcualted spatial  lags (#88)
+  - fix for v2.3.3 docs (#160)
+  - Follow up work for release of giddy 2.3.3 (#159)
+
+## Pull Requests
+  - small edits to long description (#187)
+  - update github action for release (#186)
+  - Prepare for v2.3.4 release (#182)
+  - Adjust and update docs  (#180)
+  - changing configuration for the testing action (#181)
+  - default esda branch master -> main (#178)
+  - Main (#177)
+  - refactor: deprecate fmpt and replace with mfpt (#171)
+  - update dev branches; test shapely dev (#176)
+  - CI update & redesign (#173)
+  - add custom codecov schema (#167)
+  - Update docs (#170)
+  - update pysal favicon (#169)
+  - update release_and_publish.yml (#166)
+  - removing unused docs materials (#168)
+  - (doc) remove unused requirements for doc building (#165)
+  - (docs) fix docs for spatial Markov (#163)
+  - (docs) remove redirection to readthedocs as the docs are now hosted on github page (#162)
+  - fix for v2.3.3 docs (#160)
+  - Follow up work for release of giddy 2.3.3 (#159)
+
+The following individuals contributed to this release:
+
+  - Wei Kang
+  - James Gaboardi
+  - Serge Rey
+
+
 # Version 2.3.3 (2020-06-10)
 
 This release does not add new functionalities for spatiotemporal analytics. Instead, it features the additional support of python 3.8 and the migration of the documentation website host from readthedocs to GitHub Page. The new docs website is http://pysal.org/giddy. 

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 PySAL-giddy for exploratory spatiotemporal data analysis
 ========================================================
 
-![Continuous Integration](https://github.com/pysal/giddy/actions/workflows/unittests.yml/badge.svg)
+[![Continuous Integration](https://github.com/pysal/giddy/actions/workflows/unittests.yml/badge.svg)](https://github.com/pysal/giddy/actions/workflows/unittests.yml)
 [![codecov](https://codecov.io/gh/pysal/giddy/branch/master/graph/badge.svg)](https://codecov.io/gh/pysal/giddy)
 [![Gitter room](https://badges.gitter.im/pysal/giddy.svg)](https://gitter.im/pysal/giddy)
 [![PyPI version](https://badge.fury.io/py/giddy.svg)](https://badge.fury.io/py/giddy)
-[![DOI](https://zenodo.org/badge/91390088.svg)](https://zenodo.org/badge/latestdoi/91390088)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7693957.svg)](https://doi.org/10.5281/zenodo.7693957)
 [![badge](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pysal/giddy/master)
 [![Downloads](https://static.pepy.tech/badge/giddy)](https://pepy.tech/project/giddy)
 
@@ -104,24 +104,24 @@ BibTeX Citation
 ---------------
 
 ```
-@software{wei_kang_2020_3887455,
+@software{wei_kang_2023_7693957,
   author       = {Wei Kang and
                   Sergio Rey and
                   Philip Stephens and
-                  Nicholas Malizia and
                   James Gaboardi and
+                  Nicholas Malizia and
                   Stefanie Lumnitz and
                   Levi John Wolf and
                   Charles Schmidt and
                   Jay Laura and
                   Eli Knaap},
-  title        = {pysal/giddy: Release v2.3.3},
-  month        = jun,
-  year         = 2020,
+  title        = {pysal/giddy: v2.3.4},
+  month        = mar,
+  year         = 2023,
   publisher    = {Zenodo},
-  version      = {v2.3.3},
-  doi          = {10.5281/zenodo.3887455},
-  url          = {https://doi.org/10.5281/zenodo.3887455}
+  version      = {v2.3.4},
+  doi          = {10.5281/zenodo.7693957},
+  url          = {https://doi.org/10.5281/zenodo.7693957}
 }
 ```
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c3310c3f5f038db6f369c06128250fea
+config: 1f8f5620c92b2c73ace58b81fd15c5ff
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/DirectionalLISA.html b/docs/DirectionalLISA.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Directional Analysis of Dynamic LISAs &#8212; giddy v2.3.3 Manual</title>
+    <title>Directional Analysis of Dynamic LISAs &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/MarkovBasedMethods.html b/docs/MarkovBasedMethods.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Spatially Explicit Markov Methods &#8212; giddy v2.3.3 Manual</title>
+    <title>Spatially Explicit Markov Methods &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/MobilityMeasures.html b/docs/MobilityMeasures.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Measures of Income Mobility &#8212; giddy v2.3.3 Manual</title>
+    <title>Measures of Income Mobility &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/RankBasedMethods.html b/docs/RankBasedMethods.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Rank based Methods &#8212; giddy v2.3.3 Manual</title>
+    <title>Rank based Methods &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/RankMarkov.html b/docs/RankMarkov.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Full Rank Markov and Geographic Rank Markov &#8212; giddy v2.3.3 Manual</title>
+    <title>Full Rank Markov and Geographic Rank Markov &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/Sequence.html b/docs/Sequence.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Alignment-based sequence methods &#8212; giddy v2.3.3 Manual</title>
+    <title>Alignment-based sequence methods &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -45,7 +45,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/generated/giddy-directional-Rose-1.png → ...95c4a810d285/giddy-directional-Rose-1.png b/docs/generated/giddy-directional-Rose-1.png → ...95c4a810d285/giddy-directional-Rose-1.png
diff --git a/docs/generated/giddy-directional-Rose-1.pdf → ...125da6a998b6/giddy-directional-Rose-1.pdf b/docs/generated/giddy-directional-Rose-1.pdf → ...125da6a998b6/giddy-directional-Rose-1.pdf
diff --git a/docs/generated/giddy-directional-Rose-1.py → ...daf4d52f33d69/giddy-directional-Rose-1.py b/docs/generated/giddy-directional-Rose-1.py → ...daf4d52f33d69/giddy-directional-Rose-1.py
diff --git a/...erated/giddy-directional-Rose-1.hires.png → ...e7ecf7/giddy-directional-Rose-1.hires.png b/...erated/giddy-directional-Rose-1.hires.png → ...e7ecf7/giddy-directional-Rose-1.hires.png
diff --git a/docs/_images/giddy-directional-Rose-1.png b/docs/_images/giddy-directional-Rose-1.png
diff --git a/docs/_modules/giddy/directional.html b/docs/_modules/giddy/directional.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.directional &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.directional &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/ergodic.html b/docs/_modules/giddy/ergodic.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.ergodic &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.ergodic &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/markov.html b/docs/_modules/giddy/markov.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.markov &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.markov &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/mobility.html b/docs/_modules/giddy/mobility.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.mobility &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.mobility &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/rank.html b/docs/_modules/giddy/rank.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.rank &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.rank &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/sequence.html b/docs/_modules/giddy/sequence.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.sequence &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.sequence &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/_modules/giddy/util.html b/docs/_modules/giddy/util.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>giddy.util &#8212; giddy v2.3.3 Manual</title>
+    <title>giddy.util &#8212; giddy v2.3.4 Manual</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           giddy</a>
-        <span class="navbar-text navbar-version pull-left"><b>2.3.3</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>2.3.4</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">