Skip to content

Commit

Permalink
Issue #32: cleans up unused and badly named folders/files
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
mahdiolfat authored and ehsanolfat committed Feb 28, 2024
1 parent d9f167e commit 6e3dde5
Showing 22 changed files with 20 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ContinuousTesting.yml
Original file line number Diff line number Diff line change
@@ -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: |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions examples/process_arma.ipynb
Original file line number Diff line number Diff line change
@@ -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"
]
},
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"]
9 changes: 0 additions & 9 deletions pyssp/routines.py

This file was deleted.

6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 5 additions & 0 deletions pyssp/state.py → ssp/state.py
Original file line number Diff line number Diff line change
@@ -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()
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/test_levinson.py
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
import logging

import numpy as np
from pyssp import levinson
from ssp import levinson


logger = logging.getLogger(__name__)
2 changes: 1 addition & 1 deletion tests/test_modeling.py
Original file line number Diff line number Diff line change
@@ -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__)
2 changes: 1 addition & 1 deletion tests/test_optimal.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
""""""

import numpy as np
from pyssp import optimal
from ssp import optimal


def test_kalman():
2 changes: 1 addition & 1 deletion tests/test_state.py
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@

import numpy as np

from pyssp import state
from ssp import state


def test_convm():

0 comments on commit 6e3dde5

Please sign in to comment.