From 9f4e0ee1b22ba84243beb65b6fb95fc4595e375b Mon Sep 17 00:00:00 2001
From: mahdiolfat <mahdiolfat@gmail.com>
Date: Wed, 28 Feb 2024 15:27:36 -0500
Subject: [PATCH] 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
---
 .github/workflows/ContinuousTesting.yml                  | 2 +-
 dev.md => developer/README_DEVELOPER.md                  | 0
 .../requirements-basic.txt                               | 0
 requirements-dev.txt => developer/requirements-dev.txt   | 0
 .../requirements-testing.txt                             | 0
 pyssp/routines.py                                        | 9 ---------
 requirements.txt                                         | 6 +++---
 {pyssp => ssp}/__init__.py                               | 0
 {pyssp => ssp}/adaptive.py                               | 0
 {pyssp => ssp}/lattice.py                                | 0
 {pyssp => ssp}/levinson.py                               | 0
 {pyssp => ssp}/modeling.py                               | 0
 {pyssp => ssp}/optimal.py                                | 0
 {pyssp => ssp}/spectrum.py                               | 0
 {pyssp => ssp}/state.py                                  | 5 +++++
 {pyssp => ssp}/system.py                                 | 0
 16 files changed, 9 insertions(+), 13 deletions(-)
 rename dev.md => developer/README_DEVELOPER.md (100%)
 rename requirements-basic.txt => developer/requirements-basic.txt (100%)
 rename requirements-dev.txt => developer/requirements-dev.txt (100%)
 rename requirements-testing.txt => developer/requirements-testing.txt (100%)
 delete mode 100644 pyssp/routines.py
 rename {pyssp => ssp}/__init__.py (100%)
 rename {pyssp => ssp}/adaptive.py (100%)
 rename {pyssp => ssp}/lattice.py (100%)
 rename {pyssp => ssp}/levinson.py (100%)
 rename {pyssp => ssp}/modeling.py (100%)
 rename {pyssp => ssp}/optimal.py (100%)
 rename {pyssp => ssp}/spectrum.py (100%)
 rename {pyssp => ssp}/state.py (92%)
 rename {pyssp => ssp}/system.py (100%)

diff --git a/.github/workflows/ContinuousTesting.yml b/.github/workflows/ContinuousTesting.yml
index 443b7ab..dada77e 100644
--- 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 dev/requirements-testing.txt
 
       - name: Static Lint
         run: |
diff --git a/dev.md b/developer/README_DEVELOPER.md
similarity index 100%
rename from dev.md
rename to developer/README_DEVELOPER.md
diff --git a/requirements-basic.txt b/developer/requirements-basic.txt
similarity index 100%
rename from requirements-basic.txt
rename to developer/requirements-basic.txt
diff --git a/requirements-dev.txt b/developer/requirements-dev.txt
similarity index 100%
rename from requirements-dev.txt
rename to developer/requirements-dev.txt
diff --git a/requirements-testing.txt b/developer/requirements-testing.txt
similarity index 100%
rename from requirements-testing.txt
rename to developer/requirements-testing.txt
diff --git a/pyssp/routines.py b/pyssp/routines.py
deleted file mode 100644
index c867555..0000000
--- a/pyssp/routines.py
+++ /dev/null
@@ -1,9 +0,0 @@
-"""Some helper routines.
-
-Note: remove this file and fine the right place for the functions.
-"""
-
-
-def back_substitution(x: list[float], p: int) -> None:
-    """Convinient recursion for an all-pole model."""
-    raise NotImplementedError()
diff --git a/requirements.txt b/requirements.txt
index 7dc9d87..a61937f 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
--r requirements-basic.txt
--r requirements-testing.txt
--r requirements-dev.txt
\ No newline at end of file
+-r developer/requirements-basic.txt
+-r developer/requirements-testing.txt
+-r developer/requirements-dev.txt
\ No newline at end of file
diff --git a/pyssp/__init__.py b/ssp/__init__.py
similarity index 100%
rename from pyssp/__init__.py
rename to ssp/__init__.py
diff --git a/pyssp/adaptive.py b/ssp/adaptive.py
similarity index 100%
rename from pyssp/adaptive.py
rename to ssp/adaptive.py
diff --git a/pyssp/lattice.py b/ssp/lattice.py
similarity index 100%
rename from pyssp/lattice.py
rename to ssp/lattice.py
diff --git a/pyssp/levinson.py b/ssp/levinson.py
similarity index 100%
rename from pyssp/levinson.py
rename to ssp/levinson.py
diff --git a/pyssp/modeling.py b/ssp/modeling.py
similarity index 100%
rename from pyssp/modeling.py
rename to ssp/modeling.py
diff --git a/pyssp/optimal.py b/ssp/optimal.py
similarity index 100%
rename from pyssp/optimal.py
rename to ssp/optimal.py
diff --git a/pyssp/spectrum.py b/ssp/spectrum.py
similarity index 100%
rename from pyssp/spectrum.py
rename to ssp/spectrum.py
diff --git a/pyssp/state.py b/ssp/state.py
similarity index 92%
rename from pyssp/state.py
rename to ssp/state.py
index 8389cfa..e8a59cd 100644
--- a/pyssp/state.py
+++ b/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 b/ssp/system.py
similarity index 100%
rename from pyssp/system.py
rename to ssp/system.py