Metadata-Version: 2.1
Name: blackmarblepy
Version: 0.1.0
Summary: Georeferenced Rasters of Nighttime Lights from NASA Black Marble data
Author-email: World Bank <github@worldbank.org>
Maintainer-email: Robert Marty <rmarty@worldbank.org>, Gabriel Stefanini Vicente <gvicente@worldbank.org>
License: MIT License
        
        Copyright (c) 2023 World Bank
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/worldbank/blackmarblepy
Project-URL: Bug Reports, https://github.com/worldbank/blackmarblepy/issues
Project-URL: Source, https://github.com/worldbank/lblackmarblepy
Keywords: nighttime lights,blackmarble,world bank
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: backoff <3,>=2
Requires-Dist: geopandas <1
Requires-Dist: h5py
Requires-Dist: httpx
Requires-Dist: numpy
Requires-Dist: pandas <3,>=2
Requires-Dist: rasterio
Requires-Dist: rasterstats
Requires-Dist: tqdm
Provides-Extra: docs
Requires-Dist: jupyter-book >=0.15.1 ; extra == 'docs'
Requires-Dist: sphinxcontrib-apidoc <1,>=0.4.0 ; extra == 'docs'

# BlackMarblePy

[![Python](https://img.shields.io/pypi/pyversions/blackmarblepy.svg)](https://badge.fury.io/py/blackmarblepy)
[![PyPI version](https://badge.fury.io/py/blackmarblepy.svg)](https://badge.fury.io/py/blackmarblepy)
[![docs](https://github.com/worldbank/blackmarblepy/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/worldbank/blackmarblepy/actions/workflows/gh-pages.yml)

**BlackMarblePy** is a Python package for working with Black Marble data. [Black Marble](https://blackmarble.gsfc.nasa.gov) is a [NASA Earth Observatory](https://earthobservatory.nasa.gov) project that provides global nighttime lights data. The package automates the process of downloading all relevant tiles from the [NASA LAADS archive](https://ladsweb.modaps.eosdis.nasa.gov/archive/allData/5000/VNP46A3/) to cover a region of interest, converting the raw files (in H5 format) to georeferenced rasters, and mosaicing rasters together when needed.

## Features

- Download Black Marble data for specific time periods and regions.
- Visualize nighttime lights using customizable color palettes.
- Calculate basic statistics from Black Marble images.
- Perform time-series analysis on nighttime lights data.

## Installation

**BlackMarblePy** is available on [PyPI](https://pypi.org); you can install it using `pip`:

```shell
pip install blackmarblepy
```

## Usage

Before downloading and extracting Black Marble data, define the NASA bearer token, and define a region of interest. For more detailed documentation and examples, please refer to the [documentation](https://worldbank.github.io/blackmarblepy).

## Contributing

Contributions are welcome! If you'd like to contribute, please follow our [contribution guidelines](CONTRIBUTING.md).

## License

This project is open-source - see the [LICENSE](LICENSE) file for details
