Release of v3.1.0 #minor

Author: ma-sadeghi

.github/workflows/style-check.yml

@@ -1,34 +1,23 @@
-name: Style Check
+name: flake8 Lint
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
-  build:
+  flake8-lint:
     runs-on: ubuntu-latest
-
+    name: Lint
     steps:
-      - uses: actions/checkout@v2
+      - name: Check out source repository
+        uses: actions/checkout@v2
+      - name: Set up Python environment
+        uses: actions/setup-python@v2
         with:
-          fetch-depth: 0              # otherwise, you will failed to push refs to dest repo
-
-      - name: Install style guide libs
-        run:
-          pip install flake8 wemake-python-styleguide
-
-      - name: Run style guide on changed portions
-        run: |
-          GIT_DIFF=$(git diff -u origin/$GITHUB_BASE_REF)
-          echo "$GIT_DIFF" | flake8 --diff
-
-      # For now, let's comment out the automated WPS style guide
-      # - name: Find changed files
-      #   run:
-      #     echo "_CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }} -- '*.py' | tr -s '\n' ' ' )" >> ${GITHUB_ENV}
-
-      # - name: wemake-python-styleguide
-      #   uses: wemake-services/wemake-python-styleguide@0.15.3
-      #   with:
-      #     reporter: 'github-pr-review'
-      #     path: "${{ env._CHANGED_FILES }}"
-      #   env:
-      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          python-version: "3.10"
+      - name: flake8 Lint
+        uses: py-actions/flake8@v2
+        with:
+          ignore: "D100,E226,F403,N806,W503,WPS111,WPS211,WPS237,WPS300,WPS305,WPS319,WPS347,WPS410,WPS437"
+          exclude: "doc/,setup.py,scripts/,tests/"
+          max-line-length: "90"
+          path: ".."
+          plugins: "flake8-bugbear==22.1.11 flake8-black"

.github/workflows/tests.yml

@@ -59,7 +59,6 @@ jobs:
             --cov-report=xml
             --color=yes
 
-
       - name: Upload coverage to Codecov
         if: (matrix.python-version == 3.9) && (matrix.os == 'ubuntu-latest')
         uses: codecov/codecov-action@v2
@@ -68,3 +67,13 @@ jobs:
           file: ./coverage.xml
           flags: unittests
           name: codecov-umbrella
+
+
+      - name: flake8 Lint
+        if: (matrix.python-version == 3.9) && (matrix.os == 'ubuntu-latest')
+        uses: py-actions/flake8@v2
+        with:
+           ignore: "D100,E226,E402,E712,E741,F401,F403,N806,W503,WPS111,WPS211,WPS237,WPS300,WPS305,WPS319,WPS347,WPS410,WPS437"
+           exclude: "docs/,scripts/,tests/,openpnm/contrib/,setup.py,openpnm/models/_doctxt.py,openpnm/models/phase/_phasedocs.py,openpnm/models/geometry/_geodocs.py"
+           max-line-length: "90"
+           path: ".."

README.md

@@ -6,7 +6,7 @@
 
 -----
 
-> WARNING: The ``dev`` branch is now **highly backwards incompatible with V2**!  We have made some MAJOR changes that will dramatically improve the usage and maintainability of OpenPNM moving forward, but it required breaking things. Specifically, we have removed the concept of Geometry and Physics objects. All simulations now require just Networks and Phases.  We are working feverishly to get this transition finalized and to update the documentation accordingly, but remember we are a small team with lots of other things distracting us.  Thanks for your patience.
+> VERSION 3.0 of OpenPNM is now out. All the [examples on the website](https://openpnm.org/_examples/index.html) are now using the features and idioms of V3. For a description of the main changes please see our [recent blog post](http://pmeal.com/posts/2022-10-10-notebook-post/). 
 
 # Overview of OpenPNM
 

docs/_examples/reference.rst

@@ -6,10 +6,26 @@ Reference
 
 .. tab-set::
 
-   .. tab-item:: Reference
+   .. tab-item:: Software
 
       .. toctree::
          :maxdepth: 1
          :glob:
 
-         ../examples/reference/**
+         ../examples/reference/architecture/**
+
+   .. tab-item:: Networks
+
+      .. toctree::
+         :maxdepth: 2
+         :glob:
+
+         ../examples/reference/networks/**
+
+   .. tab-item:: Simulations
+
+      .. toctree::
+         :maxdepth: 2
+         :glob:
+
+         ../examples/reference/simulations/**

docs/index.rst

@@ -3,11 +3,6 @@
 .. module:: openpnm
    :noindex:
 
-.. warning::
-
-   This documentation is under active development, and is not ready yet.
-   We aim to release OpenPNM v3 by mid September 2022.
-
 .. image:: ./_static/images/openpnm_logo.jpg
    :name: banner