Issue #32: cleans up unused and badly named folders/files

- rename pyssp to ssp to match repo and package name - new developer/ folder with dev related files - renamed dev.md file to README_DEVEVELOPER.MD under new folder - updated all files affected by the renamings
mahdiolfat · Feb 28, 2024 · 6e3dde5 · 6e3dde5
1 parent d9f167e
commit 6e3dde5
Show file tree

Hide file tree

Showing 22 changed files with 20 additions and 24 deletions.
diff --git a/.github/workflows/ContinuousTesting.yml b/.github/workflows/ContinuousTesting.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip setuptools wheel
-          pip install -r requirements-testing.txt
+          pip install -r developer/requirements-testing.txt
 
       - name: Static Lint
         run: |

diff --git a/dev.md → developer/README_DEVELOPER.md b/dev.md → developer/README_DEVELOPER.md
diff --git a/requirements-basic.txt → developer/requirements-basic.txt b/requirements-basic.txt → developer/requirements-basic.txt
diff --git a/requirements-dev.txt → developer/requirements-dev.txt b/requirements-dev.txt → developer/requirements-dev.txt
diff --git a/requirements-testing.txt → developer/requirements-testing.txt b/requirements-testing.txt → developer/requirements-testing.txt
diff --git a/examples/process_arma.ipynb b/examples/process_arma.ipynb
@@ -7,7 +7,7 @@
    "outputs": [],
    "source": [
     "import os, sys\n",
-    "dir = os.path.abspath('../pyssp')\n",
+    "dir = os.path.abspath('../ssp')\n",
     "dir = os.path.dirname(dir)\n",
     "sys.path.append(dir)"
    ]
@@ -19,7 +19,7 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
-    "from pyssp.system import ARMA\n",
+    "from ssp.system import ARMA\n",
     "import matplotlib.pyplot as plt"
    ]
   },

diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "pyssp"
+name = "ssp"
 version = "0.0.1"
 readme = "README.md"
 license = "LICENSE.txt"
@@ -13,11 +13,11 @@ pythonpath = "."
 log_cli = true
 addopts = [
     "--import-mode=importlib",
-    "--cov=pyssp"
+    "--cov=ssp"
 ]
 
 [tool.ruff]
-include = ["pyssp/**"]
+include = ["ssp/**"]
 
 line-length = 100
 indent-width = 4
@@ -50,11 +50,11 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.mypy]
-mypy_path = "pyssp"
+mypy_path = "ssp"
 ignore_missing_imports = true
 disallow_incomplete_defs = true
 disallow_untyped_calls = true
 disallow_untyped_defs = true
 disallow_untyped_decorators = true
 plugins = "numpy.typing.mypy_plugin"
-files = ["pyssp/*.py"]
+files = ["ssp/*.py"]
diff --git a/pyssp/routines.py b/pyssp/routines.py
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
--r requirements-basic.txt
--r requirements-testing.txt
--r requirements-dev.txt
+-r developer/requirements-basic.txt
+-r developer/requirements-testing.txt
+-r developer/requirements-dev.txt
diff --git a/pyssp/__init__.py → ssp/__init__.py b/pyssp/__init__.py → ssp/__init__.py
diff --git a/pyssp/adaptive.py → ssp/adaptive.py b/pyssp/adaptive.py → ssp/adaptive.py
diff --git a/pyssp/lattice.py → ssp/lattice.py b/pyssp/lattice.py → ssp/lattice.py
diff --git a/pyssp/levinson.py → ssp/levinson.py b/pyssp/levinson.py → ssp/levinson.py
diff --git a/pyssp/modeling.py → ssp/modeling.py b/pyssp/modeling.py → ssp/modeling.py
diff --git a/pyssp/optimal.py → ssp/optimal.py b/pyssp/optimal.py → ssp/optimal.py
diff --git a/pyssp/spectrum.py → ssp/spectrum.py b/pyssp/spectrum.py → ssp/spectrum.py
diff --git a/pyssp/state.py → ssp/state.py b/pyssp/state.py → ssp/state.py
@@ -61,3 +61,8 @@ def nywe(x: ArrayLike, p: int, q: int) -> NoReturn:
 def ndeterministic(x: ArrayLike, p: int, q: int) -> NoReturn:
     """Normal Determenistic Systems of Equations."""
     raise NotImplementedError()
+
+
+def back_substitution(x: list[float], p: int) -> NoReturn:
+    """Convinient recursion for an all-pole model."""
+    raise NotImplementedError()
diff --git a/pyssp/system.py → ssp/system.py b/pyssp/system.py → ssp/system.py
diff --git a/tests/test_levinson.py b/tests/test_levinson.py
@@ -3,7 +3,7 @@
 import logging
 
 import numpy as np
-from pyssp import levinson
+from ssp import levinson
 
 
 logger = logging.getLogger(__name__)

diff --git a/tests/test_modeling.py b/tests/test_modeling.py
@@ -4,7 +4,7 @@
 
 import numpy as np
 import scipy.signal as signal
-from pyssp import modeling, system
+from ssp import modeling, system
 
 
 logger = logging.getLogger(__name__)

diff --git a/tests/test_optimal.py b/tests/test_optimal.py
@@ -1,7 +1,7 @@
 """"""
 
 import numpy as np
-from pyssp import optimal
+from ssp import optimal
 
 
 def test_kalman():

diff --git a/tests/test_state.py b/tests/test_state.py
@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from pyssp import state
+from ssp import state
 
 
 def test_convm():