release v0.3.1

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 <!--next-version-placeholder-->
 
+## v0.3.1 (16/09/2023)
+
+**Code improvements**:
+
+- Fix MPI to be symmetric (https://github.com/frank1010111/pywaterflood/pull/47)
+- Cleaner rust import (https://github.com/frank1010111/pywaterflood/pull/54)
+
+**Documentation**:
+
+- 35 update docs by @frank1010111 in https://github.com/frank1010111/pywaterflood/pull/36
+- :memo: add MPI example by @frank1010111 in https://github.com/frank1010111/pywaterflood/pull/47
+- Submit to joss by @frank1010111 in https://github.com/frank1010111/pywaterflood/pull/50
+
 ## v0.3.0 (03/05/2023)
 
 Code improvements:
@@ -11,7 +24,7 @@ Code improvements:
 Non-code improvements:
 
 - Pre commit changes by @frank1010111 in https://github.com/frank1010111/pywaterflood/pull/27
-- :hammer: :bug: update pandas version to fix numpy incompatiblility
+- update pandas version to fix numpy incompatiblility
 
 ## v0.2.0 (21/05/2022)
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pywaterflood"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2018"
 
 

pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "pywaterflood"
-version = "0.3.0"
+version = "0.3.1"
 description = "Physics-inspired waterflood performance modeling"
-authors = [{name = "Frank Male", email ="[email protected]"}]
-license = {file = "LICENSE"}
+authors = [{ name = "Frank Male", email = "[email protected]" }]
+license = { file = "LICENSE" }
 readme = "README.md"
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -24,11 +24,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-test = [
-    "pytest >=6.2.5",
-    "pytest-cov >=3.0.0",
-    "coverage[toml] >=6.3.3",
-]
+test = ["pytest >=6.2.5", "pytest-cov >=3.0.0", "coverage[toml] >=6.3.3"]
 docs = [
     "furo",
     "myst-nb",
@@ -38,10 +34,7 @@ docs = [
     "sphinx-design",
     "sphinx-sitemap",
 ]
-devwork = [
-    "ipykernel",
-    "seaborn",
-]
+devwork = ["ipykernel", "seaborn"]
 
 [project.urls]
 repository = "https://github.com/frank1010111/pywaterflood"
@@ -66,58 +59,55 @@ timid = true
 
 [tool.coverage.report]
 show_missing = true
-exclude_lines = [
-    "pyversion",
-    "@jit",
-    "@njit",
-]
+exclude_lines = ["pyversion", "@jit", "@njit"]
 
 [tool.ruff]
 select = [
-  "E", "F", "W", # flake8
-  "B", "B904",    # flake8-bugbear
-  "I",           # isort
-  "ARG",         # flake8-unused-arguments
-  "C4",          # flake8-comprehensions
-  "EM",          # flake8-errmsg
-  "ICN",         # flake8-import-conventions
-  "ISC",         # flake8-implicit-str-concat
-  "PGH",         # pygrep-hooks
-  "PIE",         # flake8-pie
-  "PL",          # pylint
-  "PT",          # flake8-pytest-style
-  "PTH",         # flake8-use-pathlib
-  "RET",         # flake8-return
-  "RUF",         # Ruff-specific
-  "SIM",         # flake8-simplify
-  "T20",         # flake8-print
-  "UP",          # pyupgrade
-  "YTT",         # flake8-2020
+    "E",
+    "F",
+    "W",    # flake8
+    "B",
+    "B904", # flake8-bugbear
+    "I",    # isort
+    "ARG",  # flake8-unused-arguments
+    "C4",   # flake8-comprehensions
+    "EM",   # flake8-errmsg
+    "ICN",  # flake8-import-conventions
+    "ISC",  # flake8-implicit-str-concat
+    "PGH",  # pygrep-hooks
+    "PIE",  # flake8-pie
+    "PL",   # pylint
+    "PT",   # flake8-pytest-style
+    "PTH",  # flake8-use-pathlib
+    "RET",  # flake8-return
+    "RUF",  # Ruff-specific
+    "SIM",  # flake8-simplify
+    "T20",  # flake8-print
+    "UP",   # pyupgrade
+    "YTT",  # flake8-2020
 ]
 extend-ignore = [
-  "PLR",    # Design related pylint codes
-  "PT004",  # Use underscore for non-returning fixture (use usefixture instead)
+    "PLR",   # Design related pylint codes
+    "PT004", # Use underscore for non-returning fixture (use usefixture instead)
 ]
 line-length = 99
 target-version = "py37"
 src = ["pywaterflood"]
 unfixable = [
-  "T20",  # Removes print statements
-  "F841", # Removes unused variables
+    "T20",  # Removes print statements
+    "F841", # Removes unused variables
 ]
 exclude = []
 flake8-unused-arguments.ignore-variadic-names = true
 isort.required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.per-file-ignores]
-"tests/**" = ["T20","D"] # testing don't need docs
-"__init__.py" = ["F401"] # imported but unused
+"tests/**" = ["T20", "D"] # testing don't need docs
+"__init__.py" = ["F401"]  # imported but unused
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-markers = [
-    "slow: mark test as slow."
-]
+markers = ["slow: mark test as slow."]
 
 
 [tool.black]