solafune-tools 0.9.2
Open tools for Solafune developers and Solafune hackers where can share developed tools in geospatial data
Requires Python: >=3.10

<h1 align="center">
<img src="https://solafune-contents.s3.ap-northeast-1.amazonaws.com/Solafune+Tools+Logo.png" width="300">
</h1><br>

<div align="center">
  
![Python](https://img.shields.io/badge/Python-%3E%3D3.10-blue?logo=python&logoColor=white)
![Latest Release](https://img.shields.io/github/v/release/solafune-inc/solafune-tools?color=brightgreen&logo=tag&logoColor=white)
![GitHub stars](https://img.shields.io/github/stars/Solafune-Inc/solafune-tools?style=social)

</div>

## Solafune-Tools: Open library for Solafune developers and hackers where you can share tools for geospatial data

This library package is an integrated open-source tool for Solafune developers, Solafune hackers, scientists, engineers, students, and anyone interested in geospatial data analysis. The solafune-tools contain many tools to help you develop your analysis like downloading STAC catalogs and Sentinel-2 imagery (from Planetary Computer) and then assembling it into a cloudless mosaic, competition_tools, community_tools, and other tools in geospatial data analysis. Other tools also will be added in the future.

### July 2025: Added 5x Super-Resolution from the competition!

## Quickstart

Install the package using `pip` or `uv pip`, recommend using `python >= 3.10`:

```bash
uv pip install solafune_tools
```

You can also install the add-on requirements, like our 5x Super Resolution model from the competition.

```bash
uv pip install solafune_tools[super_resolution]
```
Or to install all the add-ons, you can also do this
```bash
uv pip install solafune_tools[full]
```

All public-facing functions have detailed docstrings explaining their expected inputs and outputs. You can check any of them through `print(solafune_tools.function_name.__doc__)` (if you don't use print it shows as an unstructured string) or `??solafune_tools.function_name` in the Jupyter notebooks.
Before using the library, you can set the directory where you want to store data by calling.

```python
solafune_tools.set_data_directory(dir_path="your_data_dir_here")
```

The above command sets the environment variable `solafune_tools_data_dir` from where all sub-modules draw their file paths. It is not set persistently (i.e., not written to `.bashrc` or similar), so you will need to put it each time you ssh into your machine or on reboot. If you do not explicitly set this, it will default to creating/using a `data` folder within your current working directory.

## Documentation

Refer to this [link](docs/README.md) for further information on each tool contained in this repository.

## Contributions

Thank you for your interest in contributing to **solafune-tools**! This project is dedicated to building powerful, open-source tools for geospatial data analysis, aiming to facilitate tasks like data processing, visualization, and spatial analysis. Contributions from the community are invaluable for improving and expanding this project, and we welcome your input!

### Credits

For those who have contributed to this OSS, We are grateful for your contribution to this development of geospatial tools. In this section, we will add a table to show users who have contributed and the users' contributed functions, stay tuned!
| Contributor | Function Developed      |
|-------------|-------------------------|
| user1       | PQS_function            |
| user2       | panoptic_metric         |
| user3       | normalization           |