Pull request #187: Master

Merge in HYP/hypernetx from master to develop * commit '0fffb4c39767c8967fcfc2eb6c29c9f5afa02815': bump: version 2.3.0 → 2.3.1 Add decorator dependency Linter Update publish-to-pypi.yml Update publish-to-pypi.yml; add workflow_dispatch Update publish-to-pypi.yml; fix python version Bump werkzeug from 3.0.2 to 3.0.3 Bump jinja2 from 3.1.3 to 3.1.4 bump: version 2.2.0 → 2.3.0 Update changelog Update release notes; add changelog
pnnl · May 17, 2024 · a565fd5 · a565fd5
2 parents 040c71d + 0fffb4c
commit a565fd5
Show file tree

Hide file tree

Showing 9 changed files with 482 additions and 29 deletions.
diff --git a/.cz.toml b/.cz.toml
@@ -1,6 +1,6 @@
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.2.0"
+version = "2.3.1"
 version_files = [
     "pyproject.toml",
     "docs/source/conf.py",

diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -12,6 +12,12 @@ on:
   release:
     types: [published]
 
+  workflow_dispatch:
+    inputs:
+      triggeredBy:
+        description: 'Name of team member who is manually triggering this workflow'
+        required: true
+
 permissions:
   contents: read
 
@@ -26,16 +32,16 @@ jobs:
     - run: echo "Building wheel from tag ${{ github.ref_name }}"
     - uses: actions/checkout@v4
 
-    - name: Build and publish distribution 📦 to Test PyPI
-      uses: JRubics/[email protected]
-      with:
-        python_version: "3.11.8"
-        pypi_token: ${{ secrets.TEST_PYPI_API_TOKEN }}
-        repository_name: "testpypi"
-        repository_url: "https://test.pypi.org/legacy/"
+    # - name: Build and publish distribution 📦 to Test PyPI
+    #   uses: JRubics/[email protected]
+    #   with:
+    #     python_version: "3.11"
+    #     pypi_token: ${{ secrets.TEST_PYPI_API_TOKEN }}
+    #     repository_name: "testpypi"
+    #     repository_url: "https://test.pypi.org/legacy/"
 
     - name: Build and publish distribution 📦 to PyPI
       uses: JRubics/[email protected]
       with:
-        python_version: "3.11.18"
+        python_version: "3.11"
         pypi_token: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/LONG_DESCRIPTION.rst b/LONG_DESCRIPTION.rst
@@ -24,28 +24,27 @@ Documentation is available at: https://pnnl.github.io/HyperNetX
 
 For questions and comments contact the developers directly at: [email protected]
 
-Summary - Release highlights - HNX 2.3
---------------------------------------
+HyperNetX 2.3
+=============
 
 HyperNetX 2.3. is the latest, stable release. The core library has been refactored to take better advantage
 of Pandas Dataframes, improve readability and maintainability, address bugs, and make it easier to change.
-New features have been added, most notably the ability to add and remove edges, nodes, and incidences.
+New features have been added, most notably the ability to add and remove edges, nodes, and incidences. Updating is recommended.
 
 **Version 2.3 is not backwards compatible. Objects constructed using earlier versions
 can be imported using their incidence dictionaries and/or property datafames.**
 
 What's New
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-#. Hypergraph now supports adding and removing edges, nodes, and incidences
-#. Hypergraph also supports the sum, difference, union, and intersection of a Hypergraph to another Hypergraph
-#. New factory methods to support the Hypergraph constructor
-#. EntitySet has been replaced by HypergraphView
-#. IncidenceStore and PropertyStore are new classes that maintain the structure and attributes of a Hypergraph
-#. Hypergraph constructors accept cell, edge, and node metadata.
-
+#. We've added new functionality to Hypergraphs; you can add and remove nodes, edges, and incidences on Hypergraph.
+#. Arithmetic operations have also been added to Hypergraph: sum, difference, union, intersection
+#. We've also added a new tutorial on basic hypergraph arithmetic operations
+#. Under the hood, the EntitySet has been replaced by HypergraphView, new factory methods have been created to support
+the Hypergraph constructor, and internal classes such as IncidenceStore and PropertyStore help maintain the structure
+and attributes of a Hypergraph
 
 What's Changed
 ~~~~~~~~~~~~~~~~~~~~~~~~~
+#. Documentation has received a major update; the Glossary and docstrings of Hypergraph have been updated.
 #. HNX now requires Python ^3.10,<=3.12
-#. HNX core libraries have been updated
-#. Updated tutorials
+#. We've upgraded all the underlying core libraries to the latest versions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,7 +19,7 @@
 import os
 
 
-__version__ = "2.2.0"
+__version__ = "2.3.1"
 
 
 # If extensions (or modules to document with autodoc) are in another directory,

diff --git a/hypernetx/__init__.py b/hypernetx/__init__.py
@@ -11,4 +11,4 @@
 from hypernetx.utils import *
 from hypernetx.utils.toys import *
 
-__version__ = "2.2.0"
+__version__ = "2.3.1"
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hypernetx"
-version = "2.2.0"
+version = "2.3.1"
 description = "HyperNetX is a Python library for the creation and study of hypergraphs."
 authors = ["Brenda Praggastis <[email protected]>", "Dustin Arendt <[email protected]>",
     "Sinan Aksoy <[email protected]>", "Emilie Purvine <[email protected]>",
@@ -28,6 +28,7 @@ pandas = ">=2.2.2"
 scikit-learn = ">=1.4.2"
 celluloid = ">=0.2.0"
 igraph = ">=0.11.4"
+decorator = "^5.1.1"
 
 [tool.poetry.group.widget]
 optional = true

diff --git a/requirements.txt b/requirements.txt
@@ -47,7 +47,7 @@ ipython-genutils==0.2.0
 ipywidgets==7.7.5
 isort==5.13.2
 jedi==0.19.1
-Jinja2==3.1.3
+Jinja2==3.1.4
 joblib==1.4.2
 jsonschema==4.22.0
 jsonschema-specifications==2023.12.1