BlackMarblePy
A Python package that provides a simple way to use nighttime lights data from NASA's Black Marble project that provides a product suite of daily, monthly and yearly global nighttime lights.
https://github.com/worldbank/blackmarblepy
Category: Sustainable Development
Sub Category: Environmental Satellites
Keywords
blackmarble datapartnership nasa nasa-data nasa-earth-data nightlights nighttime-lights raster-data viirs worldbank zonal-statistics
Keywords from Contributors
archiving measurements transformer observation optimizer projections conversion parallel mock retry
Last synced: about 5 hours ago
JSON representation
Repository metadata
Georeferenced Rasters and Statistics of Nightlights from NASA Black Marble
- Host: GitHub
- URL: https://github.com/worldbank/blackmarblepy
- Owner: worldbank
- License: mpl-2.0
- Created: 2023-10-26T09:17:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-10T20:08:11.000Z (17 days ago)
- Last Synced: 2025-04-17T20:41:02.977Z (10 days ago)
- Topics: blackmarble, datapartnership, nasa, nasa-data, nasa-earth-data, nightlights, nighttime-lights, raster-data, viirs, worldbank, zonal-statistics
- Language: Jupyter Notebook
- Homepage: https://worldbank.github.io/blackmarblepy/
- Size: 24.4 MB
- Stars: 42
- Watchers: 11
- Forks: 12
- Open Issues: 21
- Releases: 9
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
README.md
BlackMarblePy
BlackMarblePy is a Python package that provides a simple way to use nighttime lights data from NASA's Black Marble project. Black Marble is a NASA Earth Science Data Systems (ESDS) project that provides a product suite of daily, monthly and yearly global nighttime lights. This package automates the process of downloading all relevant tiles from the NASA LAADS DAAC to cover a region of interest, converting the raw files (in HDF5 format), to georeferenced rasters, and mosaicking rasters together when needed.
Features
- Download daily, monthly, and yearly nighttime lights data for user-specified region of interest and time.
- Parallel downloading for faster data retrieval and automatic retry mechanism for handling network errors.
- Access NASA Black Marble as a xarray.Dataset
- Integrated data visualization with customization options
- Choose between various plot types, including bar charts, line graphs, and heatmaps.
- Customize plot appearance with color palettes, axes labels, titles, and legends.
- Save visualizations as high-resolution images for presentations or reports.
- Perform time series analysis on nighttime lights data.
- Calculate zonal statistics like mean and sum.
- Plot time series of nighttime lights data.
- Integrated data visualization with customization options
Documentation
The BlackMarblePy library allows you to interact with and manipulate data from NASA's Black Marble, which provides global nighttime lights data. Below is a guide on how to use the key functionalities of the library.
Installation
BlackMarblePy is available on PyPI as blackmarblepy and can installed using pip
:
From PyPI
pip install blackmarblepy
From Source
-
Clone or download this repository to your local machine. Then, navigate to the root directory of the repository:
git clone https://github.com/worldbank/blackmarblepy.git cd blackmarblepy
-
Create a virtual environment (optional but recommended):
python3 -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install the package with dependencies:
pip install .
Install the package in editable mode with dependencies:
pip install -e .
The
-e
flag stands for "editable," meaning changes to the source code will immediately affect the installed package.
Building Documentation Locally
To build the documentation locally, after (1) and (2) above, please follow these steps:
-
Install the package with documentation dependencies:
pip install -e .[docs]
-
Build the documentation:
sphinx-build docs _build/html -b html
The generated documentation will be available in the _build/html
directory. Open the index.html
file in a web browser to view it.
Usage
Before downloading and extracting Black Marble data, define the NASA LAADS archive bearer
token, and define a region of interest (i.e., gdf
as a geopandas.GeoDataFrame
).
from blackmarble.raster import bm_raster
# Retrieve VNP46A2 for date range into a Xarray Dataset
daily = bm_raster(
gdf,
product_id="VNP46A2",
date_range=pd.date_range("2022-01-01", "2022-03-31", freq="D"),
bearer=bearer,
)
For more detailed information and examples, please refer to the examples.
Full API Reference
For a full reference of all available functions and their parameters, please refer to the official documentation.
Contributing
We welcome contributions to improve this documentation. If you find errors, have suggestions, or want to add new content, please follow our contribution guidelines.
Feedback and Issues
If you have any feedback, encounter issues, or want to suggest improvements, please open an issue.
Versioning
This project follows the CALVER (Calendar Versioning) scheme for versioning. If you have any questions or need more information about our versioning approach, feel free to ask.
Contributors
This project follows the all-contributors specification.
Contributions of any kind are welcome!
Citation
When using BlackMarblePy, your support is much appreciated! Please consider using the following citation or download bibliography.bib:
@misc{blackmarblepy,
title = {{BlackMarblePy: Georeferenced Rasters and Statistics of Nighttime Lights from NASA Black Marble}},
author = {Gabriel {Stefanini Vicente} and Robert Marty},
year = {2023},
howpublished = {\url{https://worldbank.github.io/blackmarblepy}},
doi = {10.5281/zenodo.10667907},
url = {https://worldbank.github.io/blackmarblepy},
}
{cite:empty}blackmarblepy
:filter: docname in docnames
:style: plain
License
This projects is licensed under the Mozilla Public License - see the LICENSE file for details.
Owner metadata
- Name: World Bank Group
- Login: worldbank
- Email: [email protected]
- Kind: organization
- Description: World Bank Repository for Data Products and tools. Content does not necessarily represent official World Bank Group positions, policies, recommendations, etc.
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/6454132?v=4
- Repositories: 182
- Last ynced at: 2023-08-06T00:01:50.096Z
- Profile URL: https://github.com/worldbank
GitHub Events
Total
- Issues event: 5
- Watch event: 11
- Member event: 1
- Issue comment event: 24
- Push event: 7
- Pull request review comment event: 2
- Pull request review event: 1
- Pull request event: 2
- Fork event: 6
- Create event: 2
Last Year
- Issues event: 5
- Watch event: 11
- Member event: 1
- Issue comment event: 24
- Push event: 7
- Pull request review comment event: 2
- Pull request review event: 1
- Pull request event: 2
- Fork event: 6
- Create event: 2
Committers metadata
Last synced: 6 days ago
Total Commits: 135
Total Committers: 5
Avg Commits per committer: 27.0
Development Distribution Score (DDS): 0.504
Commits in past year: 23
Committers in past year: 4
Avg Commits per committer in past year: 5.75
Development Distribution Score (DDS) in past year: 0.435
Name | Commits | |
---|---|---|
Rob Marty | r****3@g****m | 67 |
Gabriel Stefanini Vicente | g****e@w****g | 43 |
Rob Marty | r****y@e****u | 14 |
pre-commit-ci[bot] | 6****] | 9 |
dependabot[bot] | 4****] | 2 |
Committer domains:
- email.wm.edu: 1
- worldbank.org: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 67
Total pull requests: 61
Average time to close issues: about 2 months
Average time to close pull requests: 7 days
Total issue authors: 22
Total pull request authors: 7
Average comments per issue: 1.49
Average comments per pull request: 0.52
Merged pull request: 48
Bot issues: 0
Bot pull requests: 21
Past year issues: 23
Past year pull requests: 27
Past year average time to close issues: 16 days
Past year average time to close pull requests: 7 days
Past year issue authors: 10
Past year pull request authors: 6
Past year average comments per issue: 2.22
Past year average comments per pull request: 0.7
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 13
Top Issue Authors
- g4brielvs (34)
- ramarty (8)
- Holly-Transport (5)
- kbjarkefur (2)
- TokyAxel (1)
- eflplaton (1)
- lnicoletti (1)
- yukinko-iwasaki (1)
- aizadyar23 (1)
- emilytheok (1)
- elbeejay (1)
- ashbate (1)
- Rasanka1991 (1)
- dpatil-fw (1)
- brissyaussieoleh (1)
Top Pull Request Authors
- g4brielvs (32)
- pre-commit-ci[bot] (11)
- dependabot[bot] (10)
- ramarty (5)
- russss (1)
- koichisato-dev (1)
- gadomski (1)
Top Issue Labels
- bug (38)
- help wanted (27)
- enhancement (14)
- question (10)
- documentation (1)
- good first issue (1)
Top Pull Request Labels
- enhancement (12)
- documentation (10)
- dependencies (10)
- bug (3)
- wontfix (1)
- github_actions (1)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 633 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 9
- Total maintainers: 1
pypi.org: blackmarblepy
Georeferenced Rasters of Nighttime Lights from NASA Black Marble data
- Homepage: https://worldbank.github.io/blackmarblepy
- Documentation: https://blackmarblepy.readthedocs.io/
- Licenses: Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <https://mozilla.org/MPL/2.0/>. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
- Latest release: 2024.8.1 (published 9 months ago)
- Last Synced: 2025-04-26T12:02:52.375Z (1 day ago)
- Versions: 9
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 633 Last month
-
Rankings:
- Dependent packages count: 10.082%
- Average: 38.691%
- Dependent repos count: 67.3%
- Maintainers (1)
Score: 12.204621593262859