Skip to content

Commit

Permalink
up
Browse files Browse the repository at this point in the history
  • Loading branch information
JulioContrerasH committed Sep 8, 2024
1 parent 125159c commit 6cf6ff4
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 55 deletions.
44 changes: 21 additions & 23 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
# Changelog
# **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]
## **[Unreleased]**

### Added
- Documentation updates and additional examples for alignment methods. 📚
### **Added**
- Documentation updates and additional examples for alignment methods.

### Changed 🛠️
- Enhanced performance optimizations in co-registration methods. 🚀
### **Changed**
- Enhanced performance optimizations in co-registration methods.

### Fixed 🐛
- Minor bug fixes in spatial alignment functions. 🔧
### **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.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.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. ✅

---
## **[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.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ We welcome contributions from the community! Every contribution, no matter how s

## **How to contribute** 🛠️

1. **Fork the repository:** Start by forking the [Satalign](https://github.com/IPL-UV/Satalign) repository to your GitHub account. 🍴
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
git clone https://github.com/IPL-UV/satalign.git
cd Satalign
```
3. **Create a branch:** Create a new branch for your feature or bug fix:
Expand Down Expand Up @@ -51,9 +51,9 @@ We welcome contributions from the community! Every contribution, no matter how s
## **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.
- 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.
- Use the [Satalign GitHub issues page](https://github.com/IPL-UV/satalign/issues) for feedback.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#

<p align="center">
<img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/banner_satalign.png" width="100%">
<img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/banner_satalign.png" width="40%">
</p>

<p align="center">
Expand Down
18 changes: 18 additions & 0 deletions docs/js/copybutton.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
document.addEventListener('DOMContentLoaded', function() {
let blocks = document.querySelectorAll('pre code');
blocks.forEach((block) => {
let button = document.createElement('button');
button.innerHTML = 'Copy';
button.classList.add('copy-button');
block.parentNode.appendChild(button);
button.addEventListener('click', () => {
let range = document.createRange();
range.selectNode(block);
window.getSelection().addRange(range);
document.execCommand('copy');
window.getSelection().removeAllRanges();
button.innerHTML = 'Copied!';
setTimeout(() => { button.innerHTML = 'Copy'; }, 2000);
});
});
});
30 changes: 30 additions & 0 deletions docs/style/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/* bottom copy */
.copy-button {
position: absolute;
right: 0;
top: 0;
padding: 5px 10px;
font-size: 12px;
background: #333;
color: white;
border: none;
cursor: pointer;
}

.copy-button:hover {
background: #555;
}

/* nav */
.md-tabs__list {
display: flex;
justify-content: space-evenly;
}

[data-md-color-primary=black] .md-header {
background-color: #596346;
}

[data-md-color-primary=black] .md-tabs {
background-color: #1a2d5d;
}
36 changes: 9 additions & 27 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,32 +48,6 @@ nav:
- Contributing: CONTRIBUTING.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
# - Tasks:
# - ./mlstac/collection/tasks/README.md
# - Remote Sensing:
# - Tensor Classification: ./mlstac/collection/tasks/TensorClassification.md
# - Tensor Regression: ./mlstac/collection/tasks/TensorRegression.md
# - Tensor Object Detection: ./mlstac/collection/tasks/TensorObjectDetection.md
# - Tensor Segmentation: ./mlstac/collection/tasks/TensorSegmentation.md
# - Tensor to Tensor: ./mlstac/collection/tasks/TensorToTensor.md

# - Multimodal:
# - Tensor to Text: ./mlstac/collection/tasks/TensorToText.md
# - Text to Tensor: ./mlstac/collection/tasks/TextToTensor.md
# - Sample:
# - ./mlstac/sample/README.md
# - Specification: ./mlstac/sample/specification.md
# - Safetensor: ./mlstac/sample/safetensor.md
# - Schema: ./mlstac/sample/squema.md
# # - Catalog:
# # - ./mlstac/catalog/README.md
# # - Specification: ./mlstac/catalog/specification.md
# # - Squema: ./mlstac/catalog/squema.md
# - Collection:
# - ./mlstac/collection/README.md
# - Specification: ./mlstac/collection/specification.md
# - Schema: ./mlstac/collection/squema.md
# - API: ./mlstac/api/README.md

# Plugins
plugins:
Expand All @@ -90,4 +64,12 @@ markdown_extensions:
- pymdownx.pathconverter
- pymdownx.tabbed
- mdx_truly_sane_lists
- pymdownx.tasklist
- pymdownx.tasklist

# Extra CSS
extra_css:
- docs/style/style.css

# Extra JavaScript
extra_javascript:
- docs/js/copybutton.js

0 comments on commit 6cf6ff4

Please sign in to comment.