Mowjsubbranch

.github/workflows/python-poetry-package.yml

@@ -28,15 +28,15 @@ jobs:
         version: 1.4.0
         virtualenvs-create: true
         installer-parallel: false
-    - name: Install contsub
+    - name: Install package
       run: |
         poetry install --with tests --no-interaction
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        poetry run flake8 contsub tests --count --select=E9,F63,F7,F82 --show-source --statistics
+        poetry run flake8 --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        poetry run flake8 contsub tests --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        poetry run flake8 --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: CI tests
       run: |
         poetry run pytest

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.12.9
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+      # Run the formatter.
+      - id: ruff-format

README.rst

@@ -1,4 +1,4 @@
-Contsub
+Mowjsub
 =======
 
 .. image:: https://img.shields.io/pypi/v/contsub.svg

docs/source/conf.py

@@ -7,31 +7,32 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 
-import contsub
 from datetime import date
 
-project = 'contsub'
-author = 'Amir Kazemi-Moridani, Sphesihle Makhathini, Mika Naidoo'
-release = '1.0.2'
-copyright = f'{date.today().year}, {author}'
+import mowjsub
 
-release = contsub.__version__
-version = contsub.__version__
+project = "contsub"
+author = "Amir Kazemi-Moridani, Sphesihle Makhathini, Mika Naidoo"
+release = "1.0.2"
+copyright = f"{date.today().year}, {author}"
+
+release = mowjsub.__version__
+version = mowjsub.__version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
-language = 'en'
+language = "en"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
-#html_static_path = ['build/html/_static']
+html_theme = "furo"
+# html_static_path = ['build/html/_static']
 
 
 needs_sphinx = "8.1"

docs/source/how-to/installation.rst

@@ -3,7 +3,7 @@
 
 Installation
 =============
-The stable version Simms 3.0 is available on `PyPI <https://pypi.org/project/contsub>`_ and can be installed using:
+The stable version Mowj-sub is available on `PyPI <https://pypi.org/project/contsub>`_ and can be installed using:
 
 .. code-block:: bash
 

contsub/__init__.py → mowjsub/__init__.py

@@ -1,9 +1,12 @@
 from importlib import metadata
+
 from omegaconf import OmegaConf
 
 __version__ = metadata.version(__package__)
 
-BIN = OmegaConf.create({
-    "im_plane": "imcontsub",
-    "vis_plane": "viscontsub",
-})
+BIN = OmegaConf.create(
+    {
+        "im_plane": "im-mowjsub",
+        "vis_plane": "vis-mowjsub",
+    }
+)

contsub/exceptions.py → mowjsub/exceptions.py

@@ -1,20 +1,26 @@
 class alreadyOpen(Exception):
     pass
 
+
 class alreadyClosed(Exception):
     pass
 
+
 class noBeamTable(Exception):
     pass
 
+
 class tableExists(Exception):
     pass
 
+
 class tableDimMismatch(Exception):
     pass
 
+
 class CubeDimIsSmall(Exception):
     pass
 
+
 class BadFitError(Exception):
-    pass
+    pass