Update README.md

README.md

@@ -1,7 +1,448 @@
 ---
 license: cc-by-4.0
 ---
-# References
+
+---
+
+license: cc-by-4.0
+pretty_name: Black Marble Leiva Project
+viewer: false
+tags:
+
+* remote-sensing
+* nighttime-lights
+* viirs
+* black-marble
+* nasa
+* daily-data
+* administrative-boundaries
+* peru
+* bolivia
+* indonesia
+* geospatial
+
+---
+
+# Black Marble Leiva Project
+
+The **Black Marble Leiva Project** is an open dataset repository for daily nighttime lights panels built from **NASA Black Marble VIIRS VNP46A2** products and aggregated to subnational administrative units.
+
+This repository is the public data layer of the project. It stores figures, metadata, final Parquet outputs, app-ready files, and documentation for country-level daily nighttime lights panels.
+
+The project currently focuses on:
+
+| Country   |   Administrative unit | Number of units | Boundary source               | Status      |
+| --------- | --------------------: | --------------: | ----------------------------- | ----------- |
+| Peru      |             Districts |           1,793 | INEI 1993 district boundaries | In progress |
+| Bolivia   |        Municipalities |             339 | QuaRCS project                | In progress |
+| Indonesia | Districts / regencies |             514 | QuaRCS project                | In progress |
+
+The long-term goal is to provide research-ready daily nighttime lights datasets for spatial analysis, local economic monitoring, environmental research, disaster and shock analysis, and interactive visualization of subnational development patterns.
+
+---
+
+## Project objective
+
+This project converts daily NASA Black Marble VIIRS nighttime lights data into administrative-level daily panels.
+
+The repository has four main objectives:
+
+1. **Publish daily administrative nighttime lights panels** for Peru, Bolivia, Indonesia, and future countries.
+2. **Provide lightweight files for interactive applications**, especially district-level or municipality-level time series.
+3. **Document data sources, boundary sources, code dependencies, and limitations** in a transparent way.
+4. **Create a citable public data product** for research and teaching.
+
+This repository does not store raw NASA rasters. It stores processed administrative-level outputs derived from NASA Black Marble data.
+
+---
+
+## Main remote sensing source
+
+The primary remote sensing product is:
+
+```text
+NASA Black Marble VNP46A2
+VIIRS/NPP Gap-Filled Lunar BRDF-Adjusted Nighttime Lights Daily L3 Global 500m product
+```
+
+The main variable used in the project is:
+
+```text
+Gap_Filled_DNB_BRDF-Corrected_NTL
+```
+
+This variable is aggregated from raster pixels to administrative polygons using zonal statistics.
+
+Typical output variables include:
+
+| Variable         | Description                                                |
+| ---------------- | ---------------------------------------------------------- |
+| `mean`           | Mean nighttime lights value within the administrative unit |
+| `median`         | Median nighttime lights value                              |
+| `sum`            | Sum of nighttime lights values                             |
+| `std`            | Standard deviation                                         |
+| `min`            | Minimum value                                              |
+| `max`            | Maximum value                                              |
+| `count`          | Number of pixels considered                                |
+| `count_valid`    | Number of valid pixels                                     |
+| `count_positive` | Number of positive-light pixels                            |
+
+Additional columns may be included depending on the country, version, and processing stage.
+
+---
+
+## Administrative boundary sources
+
+Administrative boundaries are used to aggregate NASA Black Marble raster pixels to subnational units.
+
+The boundary source differs by country:
+
+| Country   | Boundary source                                                                                               | Redistribution policy            |
+| --------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------- |
+| Peru      | District map associated with the 1993 Peruvian census, facilitated by INEI to the maintainer for research use | May be included when appropriate |
+| Bolivia   | QuaRCS project                                                                                                | Not redistributed by default     |
+| Indonesia | QuaRCS project                                                                                                | Not redistributed by default     |
+
+For Peru, this repository may include simplified district boundaries for web visualization.
+
+For Bolivia and Indonesia, the original administrative boundary geometries come from the QuaRCS project and are not redistributed here by default. This repository documents the boundary source and preserves compatible administrative identifiers, names, and metadata needed to interpret the processed nighttime lights outputs.
+
+Users who need the original Bolivia or Indonesia geometries should consult the corresponding QuaRCS source.
+
+---
+
+## Repository structure
+
+The repository is organized by country.
+
+```text
+BlackMarbleLeivaProject/
+│
+├── README.md
+├── REFERENCES.md
+├── catalog.yml
+│
+├── Bolivia339/
+│   ├── figures/
+│   ├── metadata/
+│   ├── daily_monthly_parquets/
+│   └── daily_app_by_unit/
+│
+├── Indonesia514/
+│   ├── figures/
+│   ├── metadata/
+│   ├── daily_monthly_parquets/
+│   └── daily_app_by_unit/
+│
+└── Peru1793/
+    ├── figures/
+    ├── metadata/
+    ├── boundaries/
+    ├── daily_monthly_parquets/
+    └── daily_app_by_unit/
+```
+
+The repository is being populated progressively. Some folders may appear before the corresponding data products are fully uploaded.
+
+---
+
+## File types
+
+### 1. Figures
+
+Each country includes precomputed figures that can be loaded directly by notebooks or web applications.
+
+Example:
+
+```text
+Bolivia339/figures/BoliviaBMln1000plus1.png
+Indonesia514/figures/IndonesiaBMln1000plus1.png
+Peru1793/figures/PeruBMln1000plus1.png
+```
+
+These figures summarize the daily nighttime lights panel and are intended for quick inspection, documentation, and the planned Streamlit app.
+
+---
+
+### 2. Monthly Parquet files
+
+Monthly Parquet files are the production-level outputs.
+
+Expected structure:
+
+```text
+Bolivia339/daily_monthly_parquets/
+├── 2012-01.parquet
+├── 2012-02.parquet
+├── 2012-03.parquet
+└── ...
+```
+
+Each monthly file contains all administrative units for all valid days in that month.
+
+These files are useful for:
+
+* monthly checkpointing,
+* quality control,
+* map visualization by date,
+* country-level processing,
+* reproducibility of the production workflow.
+
+---
+
+### 3. App-ready files by administrative unit
+
+For interactive applications, the repository may include lightweight files by administrative unit.
+
+Expected structure:
+
+```text
+Bolivia339/daily_app_by_unit/
+├── unit_id=10101.parquet
+├── unit_id=10102.parquet
+├── unit_id=10103.parquet
+└── ...
+```
+
+Each file contains the full daily time series for one administrative unit.
+
+This structure allows a web application to load one district, municipality, or regency without loading the full country-level dataset.
+
+These files are useful for:
+
+* Streamlit applications,
+* fast district-level queries,
+* time-series visualization,
+* individual unit downloads,
+* comparison with country averages.
+
+---
+
+### 4. Metadata files
+
+Each country should include metadata files such as:
+
+```text
+metadata/
+├── units.parquet
+├── country_mean.parquet
+├── country_summary.json
+├── boundary_source.md
+├── code_source.md
+└── variable_dictionary.csv
+```
+
+Expected metadata fields may include:
+
+| Field              | Description                                          |
+| ------------------ | ---------------------------------------------------- |
+| `country`          | Country name                                         |
+| `unit_id`          | Administrative unit identifier                       |
+| `unit_name`        | Administrative unit name                             |
+| `admin1_name`      | First-level administrative unit                      |
+| `admin2_name`      | Second-level administrative unit, when available     |
+| `lat`              | Approximate centroid latitude                        |
+| `lon`              | Approximate centroid longitude                       |
+| `area_km2`         | Approximate area in square kilometers                |
+| `boundary_source`  | Source of the administrative boundary file           |
+| `boundary_version` | Version or date of the boundary file, when available |
+
+---
+
+## Code access and reproducibility
+
+The public data outputs are stored in this Hugging Face repository.
+
+The full construction workflow may depend on:
+
+* private Hugging Face repositories,
+* authenticated NASA Earthdata access,
+* Google Colab notebooks,
+* external QuaRCS boundary repositories,
+* temporary processing files not stored in this repository.
+
+For the Peru workflow, some notebooks may read source files from private repositories controlled by the maintainer.
+
+For Bolivia and Indonesia, the workflows may read administrative boundaries from QuaRCS project repositories.
+
+This means that the public outputs are documented and citable, but not every construction notebook is guaranteed to be fully executable by every user without access to the corresponding private or external source repositories.
+
+---
+
+## Colab notebooks
+
+The project includes two types of notebooks:
+
+1. **Visualization notebooks**
+   These notebooks load outputs and generate maps, figures, and diagnostics.
+
+2. **Compilation notebooks**
+   These notebooks document the construction process used to generate the daily administrative panels.
+
+Some notebooks may depend on private or authenticated data sources.
+
+### Visualization notebooks
+
+| Country   | Notebook                                                                              |
+| --------- | ------------------------------------------------------------------------------------- |
+| Peru      | https://colab.research.google.com/drive/1r-mUvxgqvey5zwrOZoeE8X2dRiRCZssT?usp=sharing |
+| Bolivia   | https://colab.research.google.com/drive/1RU_lmnR3IAXF3WZv6ZlkuvaiqdWLtftg?usp=sharing |
+| Indonesia | https://colab.research.google.com/drive/1y_fHSBKanW11fl66UyB9DIg-uRJ0xBgz?usp=sharing |
+
+### Compilation notebooks
+
+| Country   | Notebook                                                                              |
+| --------- | ------------------------------------------------------------------------------------- |
+| Peru      | https://colab.research.google.com/drive/1wpKVihAOicNo8Ie993_PMscq9bWPWi_u?usp=sharing |
+| Bolivia   | https://colab.research.google.com/drive/1oMcHZpL4_Arx-osgxwGUyA2q-HMI8JDa?usp=sharing |
+| Indonesia | https://colab.research.google.com/drive/19e15HJZFRPXggH_3wb76cPSlCKUKMofV?usp=sharing |
+
+---
+
+## Planned Streamlit application
+
+A companion Streamlit application is planned for interactive exploration of the datasets.
+
+The app is designed to allow users to:
+
+* select a country,
+* view the main country-level figure,
+* select an administrative unit,
+* visualize the daily nighttime lights series,
+* compare the selected unit against the national mean,
+* download the selected unit-level dataset,
+* access full Parquet files from Hugging Face,
+* read methodology and limitations.
+
+The Streamlit app will not process raw rasters. It will only read final Parquet outputs, metadata, and precomputed figures.
+
+---
+
+## Recommended usage
+
+### Load one administrative unit
+
+```python
+import pandas as pd
+
+path = "hf://datasets/faviolc/BlackMarbleLeivaProject/Bolivia339/daily_app_by_unit/unit_id=10101.parquet"
+
+df = pd.read_parquet(path)
+
+print(df.head())
+```
+
+### Load one monthly file
+
+```python
+import pandas as pd
+
+path = "hf://datasets/faviolc/BlackMarbleLeivaProject/Bolivia339/daily_monthly_parquets/2012-01.parquet"
+
+df = pd.read_parquet(path)
+
+print(df.head())
+```
+
+### Load metadata
+
+```python
+import pandas as pd
+
+path = "hf://datasets/faviolc/BlackMarbleLeivaProject/Bolivia339/metadata/units.parquet"
+
+units = pd.read_parquet(path)
+
+print(units.head())
+```
+
+---
+
+## Methodological summary
+
+The workflow follows these general steps:
+
+1. Define the country and administrative boundaries.
+2. Load the daily NASA Black Marble VNP46A2 product.
+3. Select the nighttime lights variable.
+4. Process rasters over the country extent.
+5. Aggregate raster pixels to administrative polygons.
+6. Save monthly checkpoint Parquet files.
+7. Validate coverage, missingness, and outliers.
+8. Export app-ready files by administrative unit.
+9. Generate figures, diagnostics, and metadata.
+10. Publish final outputs to Hugging Face.
+
+---
+
+## Known limitations
+
+Users should interpret the data with care. Nighttime lights products may be affected by:
+
+* cloud contamination,
+* snow or surface reflectance issues,
+* lunar illumination correction limits,
+* auroras and atmospheric effects,
+* sensor noise,
+* fires, gas flaring, fishing fleets, or temporary light sources,
+* administrative boundary inconsistencies,
+* missing or low-quality observations,
+* extreme outliers or artifacts in specific dates.
+
+The datasets are research-ready outputs, but they should not be interpreted as direct measurements of income, population, electricity consumption, or economic activity without additional validation.
+
+---
+
+## Citation
+
+If you use this dataset, please cite:
+
+1. this Hugging Face dataset repository,
+2. NASA Black Marble VNP46A2,
+3. the Black Marble product-suite reference,
+4. BlackMarblePy, if you use or reproduce the workflow,
+5. the corresponding administrative boundary source for the country used.
+
+Suggested citation for this repository:
+
+```text
+Leiva Cárdenas, Favio Sergio. Black Marble Leiva Project: Daily VIIRS Nighttime Lights Administrative Panels for Peru, Bolivia, and Indonesia. Hugging Face Dataset Repository.
+```
+
+Please see `REFERENCES.md` for full suggested citations.
+
+---
+
+## License
+
+This dataset repository is released under the **Creative Commons Attribution 4.0 International License**.
+
+You are free to share and adapt the processed data, provided that appropriate credit is given.
+
+Administrative boundary source files may be subject to their own source terms and are documented separately.
+
+---
+
+## Disclaimer
+
+This repository is an independent research project. It is not an official NASA, World Bank, INEI, QuaRCS, or government product.
+
+NASA Black Marble data are the original remote sensing source. This repository provides processed administrative-level outputs derived from those data.
+
+Administrative boundary sources are documented for transparency. Redistribution of boundary geometries depends on the corresponding source terms.
+
+---
+
+## Contact
+
+Maintainer:
+
+**Favio Sergio Leiva Cárdenas**
+
+For questions, suggestions, or collaboration, please use the Hugging Face community tab or contact the maintainer through the associated project channels.
+
+
+## References
 
 This file documents the main data sources, software tools, administrative boundary sources, and suggested citations for the **Black Marble Leiva Project**.