From 1d975c196e6951493ebed5cf2b68585f21a596cf Mon Sep 17 00:00:00 2001 From: Julio Cesar Contreras Huerta <126512018+JulioContrerasH@users.noreply.github.com> Date: Sun, 8 Sep 2024 20:22:56 +0200 Subject: [PATCH] up --- CHANGELOG.md | 44 +++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 10 +++++----- README.md | 10 ++++++---- docs/js/copybutton.js | 18 ++++++++++++++++++ docs/style/style.css | 30 +++++++++++++++++++++++++++++ mkdocs.yml | 8 ++++++++ 6 files changed, 111 insertions(+), 9 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 docs/js/copybutton.js create mode 100644 docs/style/style.css diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e49cb2b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,44 @@ +# **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** +- Improved efficiency of Quad-Tree compression for larger satellite images. +- Support for advanced pseudo-MTF calculations based on image compression levels. +- Enhanced classification map generation for compressed images. + +### **Changed** +- Optimized image reconstruction speed after decompression. +- Updated documentation with more detailed examples and improved clarity. + +### **Fixed** +- Fixed issue where memory usage spiked during large image decompression. +- Resolved bug causing incorrect detail error thresholds in the compression algorithm. + +## **[0.0.3] - 2024-07-13** + +### **Added** +- Added new API for creating classification maps based on Quad-Tree compression. +- Fine-tuning options for adjusting the detail error threshold in image compression. + +### **Changed** +- Improved performance of pseudo-MTF calculations for compressed images. + +## **[0.0.2] - 2024-07-12** + +### **Added** +- Introduced support for multi-channel satellite images in compression and reconstruction processes. +- Enhanced image compression using a customizable Quad-Tree structure. + +### **Fixed** +- Fixed memory leak issue when processing large satellite images during compression. + +## **[0.0.1] - 2024-07-12** + +### **Added** +- Initial release of **satcompression** with basic Quad-Tree compression and decompression functionality for satellite images. +- Support for encoding and decoding image data using the Quad-Tree structure. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5ebeb2..02e2e08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,8 @@ We welcome contributions from the community! Every contribution, no matter how s 2. **Clone your fork locally:** ```bash cd - git clone https://github.com/IPL-UV/sathybrid.git - cd sathybrid + git clone https://github.com/IPL-UV/satcompression.git + cd satcompression ``` 3. **Create a branch:** Create a new branch for your feature or bug fix: ```bash @@ -43,7 +43,7 @@ We welcome contributions from the community! Every contribution, no matter how s ```bash tox ``` -7. **Submit a pull request:** πŸš€ Push your branch to GitHub and submit a pull request to the `develop` branch of the `sathybrid` repository. Ensure your pull request meets these guidelines: +7. **Submit a pull request:** πŸš€ Push your branch to GitHub and submit a pull request to the `develop` branch of the `satcompression` 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. @@ -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 [sathybrid GitHub repository](https://github.com/YOUR_GITHUB_USERNAME/sathybrid/issues). Please include your operating system, setup details, and steps to reproduce the bug. + - Report bugs by creating an issue on the [satcompression GitHub repository](https://github.com/IPL-UV/satcompression/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 [sathybrid GitHub issues page](https://github.com/YOUR_GITHUB_USERNAME/sathybrid/issues) for feedback. \ No newline at end of file + - Use the [satcompression GitHub issues page](https://github.com/IPL-UV/sathybrid/issues) for feedback. \ No newline at end of file diff --git a/README.md b/README.md index 5a564a8..da28f37 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # + +

- +

@@ -25,7 +27,7 @@ --- -**GitHub**: [https://github.com/YOUR_GITHUB_USERNAME/satcompression](https://github.com/YOUR_GITHUB_USERNAME/satcompression) 🌐 +**GitHub**: [https://github.com/IPL-UV/satcompression](https://github.com/IPL-UV/satcompression) 🌐 **PyPI**: [https://pypi.org/project/satcompression/](https://pypi.org/project/satcompression/) πŸ› οΈ @@ -83,7 +85,7 @@ image_data_decompress = satcompression.reconstruct_image_data(

-### **Calculate Pseudo-MTF from Quad-Tree decomposition** πŸ“Š +### **Calculate pseudo-MTF from Quad-Tree decomposition** πŸ“Š #### **Load libraries** @@ -112,7 +114,7 @@ plt.ylim(0, 1.2) plt.title("Pseudo-MTF obtained from the quadtree decomposition") plt.show() ``` -### **Create a classification Map from the Quad-Tree nodes** πŸ—ΊοΈ +### **Create a classification map from the Quad-Tree nodes** πŸ—ΊοΈ #### **Load libraries** diff --git a/docs/js/copybutton.js b/docs/js/copybutton.js new file mode 100644 index 0000000..d66a9ab --- /dev/null +++ b/docs/js/copybutton.js @@ -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); + }); + }); +}); diff --git a/docs/style/style.css b/docs/style/style.css new file mode 100644 index 0000000..12043e6 --- /dev/null +++ b/docs/style/style.css @@ -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: #0e91d8; +} + +[data-md-color-primary=black] .md-tabs { + background-color: #71e2d7; +} diff --git a/mkdocs.yml b/mkdocs.yml index 0b41867..afaf915 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,3 +65,11 @@ markdown_extensions: - pymdownx.tabbed - mdx_truly_sane_lists - pymdownx.tasklist + +# Extra CSS +extra_css: + - docs/style/style.css + +# Extra JavaScript +extra_javascript: + - docs/js/copybutton.js