up

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/python
 {
-    "name": "satsync",
+    "name": "satalign",
     // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
     "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
     "features": {
@@ -22,8 +22,8 @@
                 "python.testing.pytestArgs": ["tests"],
                 "python.testing.unittestEnabled": false,
                 "python.testing.pytestEnabled": true,
-                "python.defaultInterpreterPath": "/workspaces/satsync/.venv/bin/python",
-                "python.testing.pytestPath": "/workspaces/satsync/.venv/bin/pytest"
+                "python.defaultInterpreterPath": "/workspaces/satalign/.venv/bin/python",
+                "python.testing.pytestPath": "/workspaces/satalign/.venv/bin/pytest"
             }
         }
     }

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to `satsync`
+# Contributing to `satalign`
 
 Contributions are welcome, and they are greatly appreciated!
 Every little bit helps, and credit will always be given.
@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ## Report Bugs
 
-Report bugs at https://github.com/csaybar/satsync/issues
+Report bugs at https://github.com/csaybar/satalign/issues
 
 If you are reporting a bug, please include:
 
@@ -33,7 +33,7 @@ Cookiecutter PyPackage could always use more documentation, whether as part of t
 
 ## Submit Feedback
 
-The best way to send feedback is to file an issue at https://github.com/csaybar/satsync/issues.
+The best way to send feedback is to file an issue at https://github.com/csaybar/satalign/issues.
 
 If you are proposing a new feature:
 
@@ -44,22 +44,22 @@ If you are proposing a new feature:
 
 # Get Started!
 
-Ready to contribute? Here's how to set up `satsync` for local development.
+Ready to contribute? Here's how to set up `satalign` for local development.
 Please note this documentation assumes you already have `poetry` and `Git` installed and ready to go.
 
-1. Fork the `satsync` repo on GitHub.
+1. Fork the `satalign` repo on GitHub.
 
 2. Clone your fork locally:
 
 ```bash
 cd <directory_in_which_repo_should_be_created>
-git clone [email protected]:YOUR_NAME/satsync.git
+git clone [email protected]:YOUR_NAME/satalign.git
 ```
 
 3. Now we need to install the environment. Navigate into the directory
 
 ```bash
-cd satsync
+cd satalign
 ```
 
 If you are using `pyenv`, select a version to use locally. (See installed versions with `pyenv versions`)

Dockerfile

@@ -16,6 +16,6 @@ COPY poetry.lock pyproject.toml /code/
 RUN poetry install --no-interaction --no-ansi --no-root --no-dev
 
 # Copy Python code to the Docker image
-COPY satsync /code/satsync/
+COPY satalign /code/satalign/
 
-CMD [ "python", "satsync/foo.py"]
+CMD [ "python", "satalign/foo.py"]

README.md

@@ -1,15 +1,15 @@
-# satsync
+# satalign
 
-[![Release](https://img.shields.io/github/v/release/csaybar/satsync)](https://img.shields.io/github/v/release/csaybar/satsync)
-[![Build status](https://img.shields.io/github/actions/workflow/status/csaybar/satsync/main.yml?branch=main)](https://github.com/csaybar/satsync/actions/workflows/main.yml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/csaybar/satsync/branch/main/graph/badge.svg)](https://codecov.io/gh/csaybar/satsync)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/csaybar/satsync)](https://img.shields.io/github/commit-activity/m/csaybar/satsync)
-[![License](https://img.shields.io/github/license/csaybar/satsync)](https://img.shields.io/github/license/csaybar/satsync)
+[![Release](https://img.shields.io/github/v/release/csaybar/satalign)](https://img.shields.io/github/v/release/csaybar/satalign)
+[![Build status](https://img.shields.io/github/actions/workflow/status/csaybar/satalign/main.yml?branch=main)](https://github.com/csaybar/satalign/actions/workflows/main.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/csaybar/satalign/branch/main/graph/badge.svg)](https://codecov.io/gh/csaybar/satalign)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/csaybar/satalign)](https://img.shields.io/github/commit-activity/m/csaybar/satalign)
+[![License](https://img.shields.io/github/license/csaybar/satalign)](https://img.shields.io/github/license/csaybar/satalign)
 
 A python package to align satellite images.
 
-- **Github repository**: <https://github.com/csaybar/satsync/>
-- **Documentation** <https://csaybar.github.io/satsync/>
+- **Github repository**: <https://github.com/csaybar/satalign/>
+- **Documentation** <https://csaybar.github.io/satalign/>
 
 ## Getting started with your project
 
@@ -19,7 +19,7 @@ First, create a repository on GitHub with the same name as this project, and the
 git init -b main
 git add .
 git commit -m "init commit"
-git remote add origin [email protected]:csaybar/satsync.git
+git remote add origin [email protected]:csaybar/satalign.git
 git push -u origin main
 ```
 
@@ -39,8 +39,8 @@ To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookie
 ## Releasing a new version
 
 - Create an API Token on [Pypi](https://pypi.org/).
-- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/satsync/settings/secrets/actions/new).
-- Create a [new release](https://github.com/csaybar/satsync/releases/new) on Github.
+- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/csaybar/satalign/settings/secrets/actions/new).
+- Create a [new release](https://github.com/csaybar/satalign/releases/new) on Github.
 - Create a new tag in the form `*.*.*`.
 
 For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

docs/index.md

@@ -1,8 +1,8 @@
-# satsync
+# satalign
 
-[![Release](https://img.shields.io/github/v/release/csaybar/satsync)](https://img.shields.io/github/v/release/csaybar/satsync)
-[![Build status](https://img.shields.io/github/actions/workflow/status/csaybar/satsync/main.yml?branch=main)](https://github.com/csaybar/satsync/actions/workflows/main.yml?query=branch%3Amain)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/csaybar/satsync)](https://img.shields.io/github/commit-activity/m/csaybar/satsync)
-[![License](https://img.shields.io/github/license/csaybar/satsync)](https://img.shields.io/github/license/csaybar/satsync)
+[![Release](https://img.shields.io/github/v/release/csaybar/satalign)](https://img.shields.io/github/v/release/csaybar/satalign)
+[![Build status](https://img.shields.io/github/actions/workflow/status/csaybar/satalign/main.yml?branch=main)](https://github.com/csaybar/satalign/actions/workflows/main.yml?query=branch%3Amain)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/csaybar/satalign)](https://img.shields.io/github/commit-activity/m/csaybar/satalign)
+[![License](https://img.shields.io/github/license/csaybar/satalign)](https://img.shields.io/github/license/csaybar/satalign)
 
 A python package to align satellite images.

docs/modules.md

@@ -1 +1 @@
-::: satsync.foo
+::: satalign.foo

mkdocs.yml

@@ -1,10 +1,10 @@
-site_name: satsync
-repo_url: https://github.com/csaybar/satsync
-site_url: https://csaybar.github.io/satsync
+site_name: satalign
+repo_url: https://github.com/csaybar/satalign
+site_url: https://csaybar.github.io/satalign
 site_description: A python package to align satellite images.
 site_author: Cesar Aybar
 edit_uri: edit/main/docs/
-repo_name: csaybar/satsync
+repo_name: csaybar/satalign
 copyright: Maintained by <a href="https://csaybar.com">Florian</a>.
 
 nav:
@@ -43,9 +43,9 @@ theme:
 extra:
   social:
     - icon: fontawesome/brands/github
-      link: https://github.com/csaybar/satsync
+      link: https://github.com/csaybar/satalign
     - icon: fontawesome/brands/python
-      link: https://pypi.org/project/satsync
+      link: https://pypi.org/project/satalign
 
 markdown_extensions:
   - toc:

pyproject.toml

@@ -1,13 +1,13 @@
 [tool.poetry]
-name = "satsync"
-version = "0.0.6"
+name = "satalign"
+version = "0.0.7"
 description = "Methods for spatial alignment of satellite imagery"
-authors = ["Cesar Aybar <fcesar[email protected]>"]
-repository = "https://github.com/csaybar/satsync"
-documentation = "https://csaybar.github.io/satsync/"
+authors = ["Cesar Aybar <cesar[email protected]>"]
+repository = "https://github.com/csaybar/satalign"
+documentation = "https://csaybar.github.io/satalign/"
 readme = "README.md"
 packages = [
-  {include = "satsync"}
+  {include = "satalign"}
 ]
 
 [tool.poetry.dependencies]
@@ -19,7 +19,7 @@ scikit-image = ">=0.23.1"
 opencv-python = ">=4.8.0.76"
 pandas = ">=2.0.3"
 kornia = ">=0.7.2"
-torch = ">=2.2.0"
+torch = ">=2.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.0"
@@ -39,7 +39,7 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.mypy]
-files = ["satsync"]
+files = ["satalign"]
 disallow_untyped_defs = "True"
 disallow_any_unimported = "True"
 no_implicit_optional = "True"
@@ -102,7 +102,7 @@ skip_empty = true
 
 [tool.coverage.run]
 branch = true
-source = ["satsync"]
+source = ["satalign"]
 
 
 [tool.ruff.per-file-ignores]

satalign/__init__.py

@@ -0,0 +1,4 @@
+from satalign import utils
+from satalign.ecc import ECC
+from satalign.lightglue import LightGlue
+from satalign.pcc import PCC

satsync/ecc.py → satalign/ecc.py

@@ -15,10 +15,10 @@
 import cv2
 import numpy as np
 
-from satsync.main import SatSync
+from satalign.main import SatAlign
 
 
-class ECC(SatSync):
+class ECC(SatAlign):
     def __init__(
         self,
         datacube: np.ndarray,

satsync/lgm.py → satalign/lgm.py

@@ -4,13 +4,13 @@
 import numpy as np
 import torch
 
-from satsync.lightglue import (ALIKED, DISK, SIFT, DoGHardNet, LightGlue,
+from satalign.lightglue import (ALIKED, DISK, SIFT, DoGHardNet, LightGlue,
                                SuperPoint)
-from satsync.lightglue.utils import rbd
-from satsync.main import SatSync
+from satalign.lightglue.utils import rbd
+from satalign.main import SatAlign
 
 
-class LGM(SatSync):
+class LGM(SatAlign):
     def __init__(
         self,
         datacube: np.ndarray,

satsync/main.py → satalign/main.py

@@ -7,7 +7,7 @@
 import numpy as np
 import xarray as xr
 
-class SatSync(ABC):
+class SatAlign(ABC):
     """
     An abstract class for multi-temporal image co-registration
 

satsync/pcc.py → satalign/pcc.py

@@ -4,10 +4,10 @@
 import numpy as np
 from skimage.registration import phase_cross_correlation
 
-from satsync.main import SatSync
+from satalign.main import SatAlign
 
 
-class PCC(SatSync):
+class PCC(SatAlign):
     def __init__(
         self,
         datacube: np.ndarray,

tests/test_foo.py

@@ -1,4 +1,4 @@
-from satsync.foo import foo
+from satalign.foo import foo
 
 
 def test_foo():