Package Health Score

70 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 437
Forks: 94
Contributors: 8

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package s2cloudless, we found that it has been starred 437 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Sep 27, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

CC-BY-SA-4.0

Security Policy

We found a way for you to contribute to the project! Looks like s2cloudless is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 2
Open PR: 0
Last Release: 3 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of s2cloudless based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that s2cloudless demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 8
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like s2cloudless is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 7 years
Latest Release: 3 months ago
Dependencies: 2 Direct
Versions: 16
Maintainers: 0
Wheels: OS Independent

Readme

Sentinel Hub's cloud detector for Sentinel-2 imagery

NOTE: s2cloudless masks are now available as a precomputed layer within Sentinel Hub. Check the announcement blog post and technical documentation.

The s2cloudless Python package provides automated cloud detection in Sentinel-2 imagery. The classification is based on a single-scene pixel-based cloud detector developed by Sentinel Hub's research team and is described in more detail in this blog.

The s2cloudless algorithm was part of an international collaborative effort aimed at intercomparing cloud detection algorithms. The s2cloudless algorithm was validated together with 9 other algorithms on 4 different test datasets and in all cases found to be on the Pareto front. See the paper

Installation

The package requires a Python version >= 3.8. The package is available on the PyPI package manager and can be installed with

$ pip install s2cloudless

To install the package manually, clone the repository and

$ pip install .

One of s2cloudless dependencies is lightgbm package. If having problems during installation, please check the LightGBM installation guide.

Before installing s2cloudless on Windows, it is recommended to install package shapely from Unofficial Windows wheels repository

Input: Sentinel-2 scenes

The inputs to the cloud detector are Sentinel-2 images. In particular, the cloud detector requires the following 10 Sentinel-2 band reflectances: B01, B02, B04, B05, B08, B8A, B09, B10, B11, B12, which are obtained from raw reflectance values in the following way: B_i/10000. From product baseline 04.00 onward additional harmonization factors have to be applied to data according to instructions from ESA.

You don't need to worry about any of this, if you are using Sentinel-2 data obtained from Sentinel Hub Process API. By default, the data is already harmonized according to documentation. The API is supported in Python with sentinelhub-py package and used within s2cloudless.CloudMaskRequest class.

Examples

A Jupyter notebook on how to use the cloud detector to produce cloud mask or cloud probability map can be found in the examples folder.

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

s2cloudless dependencies

opencv-python-headless typing-extensions

FAQs

What is s2cloudless?

Sentinel Hub's cloud detector for Sentinel-2 imagery. Visit Snyk Advisor to see a full health score report for s2cloudless, including popularity, security, maintenance & community analysis.

Is s2cloudless popular?

The python package s2cloudless receives a total of 2,126 weekly downloads. As such, s2cloudless popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is s2cloudless well maintained?

We found that s2cloudless demonstrated a healthy version release cadence and project activity. It has a community of 8 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is s2cloudless safe to use?

The python package s2cloudless was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 03:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

s2cloudless