https://github.com/simonsobs/imagetree

Image processing library that uses quadtrees to simplify working with very large files
https://github.com/simonsobs/imagetree

Last synced: 8 months ago
JSON representation

Image processing library that uses quadtrees to simplify working with very large files

• Host: GitHub
• URL: https://github.com/simonsobs/imagetree
• Owner: simonsobs
• License: mit
• Created: 2023-10-09T18:33:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-10T15:15:03.000Z (over 2 years ago)
• Last Synced: 2024-12-27T04:25:36.331Z (over 1 year ago)
• Language: Python
• Size: 127 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          


ImageTree


[![Build status](https://github.com/simonsobs/imagetree/workflows/build/badge.svg)](https://github.com/simonsobs/imagetree/actions?query=workflow%3Abuild)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/simonsobs/imagetree/blob/main/.pre-commit-config.yaml)

[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/simonsobs/imagetree/releases)

[![License](https://img.shields.io/github/license/simonsobs/imagetree)](https://github.com/simonsobs/imagetree/blob/main/LICENSE)

ImageTree is an image processing library that uses quadtrees to simplify working with very large files.



## Installation

```bash

pip install -U imagetree

```

or install with `Poetry`

```bash

poetry add imagetree

```

### Makefile usage

[`Makefile`](https://github.com/simsonsobs/imagetree/blob/main/Makefile) contains a lot of functions for faster development.

1. Download and remove Poetry



To download and install Poetry run:

```bash

make poetry-download

```

To uninstall

```bash

make poetry-remove

```



2. Install all dependencies and pre-commit hooks



Install requirements:

```bash

make install

```

Pre-commit hooks coulb be installed after `git init` via

```bash

make pre-commit-install

```



3. Codestyle



Automatic formatting uses `pyupgrade`, `isort` and `black`.

```bash

make codestyle

# or use synonym

make formatting

```

Codestyle checks only, without rewriting files:

```bash

make check-codestyle

```

> Note: `check-codestyle` uses `isort`, `black` and `darglint` library

Update all dev libraries to the latest version using one comand

```bash

make update-dev-deps

```



## 📈 Releases

You can see the list of available releases on the [GitHub Releases](https://github.com/simsonsobs/imagetree/releases) page.

We follow [Semantic Versions](https://semver.org/) specification.

We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

## 🛡 License

[![License](https://img.shields.io/github/license/simsonsobs/imagetree)](https://github.com/simsonsobs/imagetree/blob/main/LICENSE)

This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/simsonsobs/imagetree/blob/main/LICENSE) for more details.

## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)

This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)