up

.github/workflows/mkdocs.yml

@@ -0,0 +1,30 @@
+name: deploy
+on:
+  push:
+    branches: [ "main" ]
+
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+          architecture: "x64"
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install wheel
+          python3 -m pip install -r requirements.txt
+      - name: Build site
+        run: mkdocs build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added ✨
+- Documentation updates and additional examples for alignment methods. 📚
+
+### Changed 🛠️
+- Enhanced performance optimizations in co-registration methods. 🚀
+
+### Fixed 🐛
+- Minor bug fixes in spatial alignment functions. 🔧
+
+## [0.1.3] - 2024-05-25
+### Added ✨
+- New methods for spatial alignment of satellite imagery. 🛰️
+- Expanded documentation with examples and usage guides. 📄
+
+## [0.1.1] - 2024-05-12
+### Added ✨
+- Initial release of Satalign with basic functionalities for image co-registration. 🛠️
+- Examples demonstrating the use of PCC, ECC, and LGM alignment methods. 📊
+
+## [0.1.0] - 2024-05-08
+### Added ✨
+- Basic structure for Satalign. 🏗️
+- Set up CI/CD pipeline with GitHub Actions. ⚙️
+- Added basic tests and coverage reports. ✅
+
+---

CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# **Contributor covenant code of conduct** 📜
+
+## **Our pledge** 🤝
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. 🌎🤗
+
+## **Our standards** 📏
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language. 😊
+- Being respectful of differing viewpoints and experiences. 🤔👂
+- Gracefully accepting constructive criticism. 🛠️
+- Focusing on what is best for the community. 🤲
+- Showing empathy towards other community members. 🥺❤️
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances. 🚫💬
+- Trolling, insulting/derogatory comments, and personal or political attacks. 🚫😠
+- Public or private harassment. 🚫👥
+- Publishing others' private information, such as a physical or electronic
+ address, without explicit permission. 🚫🏡
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting. 🚫👔
+
+## **Our responsibilities** 🛡️
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## **Scope** 🌐
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## **Enforcement** 🚨
+
+<!-- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]).  -->
+All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## **Attribution** 👏
+
+This Code of Conduct is adapted from the [Contributor covenant][homepage], version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: <https://www.contributor-covenant.org>
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

@@ -1,133 +1,59 @@
-# Contributing to `satalign`
-
-Contributions are welcome, and they are greatly appreciated!
-Every little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-# Types of Contributions
-
-## Report Bugs
-
-Report bugs at https://github.com/csaybar/satalign/issues
-
-If you are reporting a bug, please include:
-
-- Your operating system name and version.
-- Any details about your local setup that might be helpful in troubleshooting.
-- Detailed steps to reproduce the bug.
-
-## Fix Bugs
-
-Look through the GitHub issues for bugs.
-Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
-
-## Implement Features
-
-Look through the GitHub issues for features.
-Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
-
-## Write Documentation
-
-Cookiecutter PyPackage could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
-
-## Submit Feedback
-
-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:
-
-- Explain in detail how it would work.
-- Keep the scope as narrow as possible, to make it easier to implement.
-- Remember that this is a volunteer-driven project, and that contributions
-  are welcome :)
-
-# Get Started!
-
-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 `satalign` repo on GitHub.
-
-2. Clone your fork locally:
-
-```bash
-cd <directory_in_which_repo_should_be_created>
-git clone [email protected]:YOUR_NAME/satalign.git
-```
-
-3. Now we need to install the environment. Navigate into the directory
-
-```bash
-cd satalign
-```
-
-If you are using `pyenv`, select a version to use locally. (See installed versions with `pyenv versions`)
-
-```bash
-pyenv local <x.y.z>
-```
-
-Then, install and activate the environment with:
-
-```bash
-poetry install
-poetry shell
-```
-
-4. Install pre-commit to run linters/formatters at commit time:
-
-```bash
-poetry run pre-commit install
-```
-
-5. Create a branch for local development:
-
-```bash
-git checkout -b name-of-your-bugfix-or-feature
-```
-
-Now you can make your changes locally.
-
-6. Don't forget to add test cases for your added functionality to the `tests` directory.
-
-7. When you're done making changes, check that your changes pass the formatting tests.
-
-```bash
-make check
-```
-
-Now, validate that all unit tests are passing:
-
-```bash
-make test
-```
-
-9. Before raising a pull request you should also run tox.
-   This will run the tests across different versions of Python:
-
-```bash
-tox
-```
-
-This requires you to have multiple versions of python installed.
-This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
-
-10. Commit your changes and push your branch to GitHub:
-
-```bash
-git add .
-git commit -m "Your detailed description of your changes."
-git push origin name-of-your-bugfix-or-feature
-```
-
-11. Submit a pull request through the GitHub website.
-
-# Pull Request Guidelines
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1. The pull request should include tests.
-
-2. If the pull request adds functionality, the docs should be updated.
-   Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.
+# **Contributing** 🤝
+
+We welcome contributions from the community! Every contribution, no matter how small, is appreciated and credited. Here’s how you can get involved:
+
+## **How to contribute** 🛠️
+
+1. **Fork the repository:** Start by forking the [Satalign](https://github.com/IPL-UV/Satalign) repository to your GitHub account. 🍴
+2. **Clone your fork locally:**
+    ```bash
+    cd <directory_in_which_repo_should_be_created>
+    git clone https://github.com/YOUR_GITHUB_USERNAME/Satalign.git
+    cd Satalign
+    ```
+3. **Create a branch:** Create a new branch for your feature or bug fix:
+    ```bash
+    git checkout -b name-of-your-bugfix-or-feature
+    ```
+4. **Set up the environment:** 🌱
+   - If you're using `pyenv`, select a Python version:
+     ```bash
+     pyenv local <x.y.z>
+     ```
+   - Install dependencies and activate the environment:
+     ```bash
+     poetry install
+     poetry shell
+     ```
+   - Install pre-commit hooks:
+     ```bash
+     poetry run pre-commit install
+     ```
+5. **Make your changes:** 🖋️ Develop your feature or fix, ensuring you write clear, concise commit messages and include any necessary tests.
+6. **Check your changes:** ✅
+   - Run formatting checks:
+     ```bash
+     make check
+     ```
+   - Run unit tests:
+     ```bash
+     make test
+     ```
+   - Optionally, run tests across different Python versions using tox:
+     ```bash
+     tox
+     ```
+7. **Submit a pull request:** 🚀 Push your branch to GitHub and submit a pull request to the `develop` branch of the Satalign repository. Ensure your pull request meets these guidelines:
+   - Include tests.
+   - Update the documentation if your pull request adds functionality.
+   - Provide a detailed description of your changes.
+
+## **Types of contributions** 📦
+
+- **Report bugs:** 🐛
+  - Report bugs by creating an issue on the [Satalign GitHub repository](https://github.com/IPL-UV/Satalign/issues). Please include your operating system, setup details, and steps to reproduce the bug.
+- **Fix bugs:** 🛠️ Look for issues tagged with "bug" and "help wanted" in the repository to start fixing.
+- **Implement features:** ✨ Contribute by implementing features tagged with "enhancement" and "help wanted."
+- **Write documentation:** 📚 Contribute to the documentation in the official docs, docstrings, or through blog posts and articles.
+- **Submit feedback:** 💬 Propose new features or give feedback by filing an issue on GitHub. 
+  - Use the [Satalign GitHub issues page](https://github.com/IPL-UV/Satalign/issues) for feedback.