Add project metadata (#60)

* Add pre-commit

* Update CONTRIBUTING

* Add CITATION

* Update documentation

* Update gitignore

* Update README

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,43 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: Bug Report
+about: Use to report a bug
 title: ''
-labels: ''
+labels: bug
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Bug Report
+
+### Description
+
+Provide a brief overview of the bug encountered. Describe the behavior observed when the bug occurs and explain the behavior expected when the bug is not present.
+
+### Reproducibility
+
+- [ ] The bug is reproducible.
+- [ ] The bug is intermittent.
+- [ ] The bug occurs only under specific conditions.
+
+#### Steps to Reproduce
+
+1. List the steps to reproduce the bug.
+2. Be as detailed as possible to help with replication.
+
+#### Screenshots / Error Messages (if applicable)
+
+Insert any relevant screenshots or error messages related to the bug.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+#### Environment
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+- **Operating System**: [e.g., Windows 10, macOS, Linux]
+- **Browser (if applicable)**: [e.g., Google Chrome, Firefox, Safari]
+- **Application Version/Commit**: [e.g., v1.2.3, Git commit hash]
+- **Additional Environment Details**: [e.g., hardware specifications, network conditions]
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Additional Context
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+Provide any additional context or information about the bug.
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+### Possible Fix
 
-**Additional context**
-Add any other context about the problem here.
+If you have suggestions for a fix, please describe them here.

.github/ISSUE_TEMPLATE/peer_review.md

@@ -0,0 +1,42 @@
+---
+name: Peer Review
+about: Use to submit a peer review
+title: ''
+labels: review
+assignees: ''
+---
+
+## Peer Review for Reproducibility Checks
+
+### Review Checklist
+
+Please review the following aspects related to reproducibility checks:
+
+- [ ] **Environment Setup**:
+  - [ ] Were detailed instructions provided for setting up the development environment?
+  - [ ] Are all necessary dependencies and libraries clearly documented?
+- [ ] **Data Preparation**:
+  - [ ] Are source data files and preprocessing steps clearly documented?
+  - [ ] Are scripts or commands for data transformation included and well-documented?
+- [ ] **Code Execution**:
+  - [ ] Were clear instructions provided for running the code?
+  - [ ] Does the code execute without errors and produce expected outputs?
+- [ ] **Configuration Management**:
+  - [ ] Is version control information (e.g., Git commit hash) included for reproducibility?
+  - [ ] Are any configuration files or parameters used properly documented?
+- [ ] **Results Verification**:
+  - [ ] Are output results (e.g., metrics, visualizations) included and matched with expected outcomes?
+  - [ ] Have any discrepancies between expected and actual results been identified and explained?
+- [ ] **Documentation**:
+  - [ ] Is there a detailed README or documentation explaining the experiment setup and execution process?
+  - [ ] Are code comments and documentation clear and informative?
+- [ ] **External Dependencies**:
+  - [ ] Are any external data sources or APIs used accessible and well-documented?
+  - [ ] Are external libraries or packages properly cited and versioned for reproducibility?
+- [ ] **Validation**:
+  - [ ] Can an independent reviewer replicate the experiment using the provided instructions?
+  - [ ] Are the results consistent across different environments or platforms?
+
+### Additional Comments
+
+Include any additional comments, concerns, or suggestions related to reproducibility.

.github/workflows/gh-pages.yml

@@ -1,4 +1,4 @@
-name: Publish to GitHub Pages
+name: gh-pages
 
 on:
   push:
@@ -9,15 +9,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
           cache: "pip"
       - name: Dependencies
         run: |
           if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
+          if [ -f pyproject.toml ]; then pip install ".[docs]"; fi
       - name: Build Jupyter Book
         run: |
           jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml

.gitignore

@@ -88,6 +88,9 @@ target/
 # Jupyter Book
 _build/
 
-/data
-
-/notebooks/hsos-survey/Figures
+# Project-specific files
+.jupyter/
+.ruff_cache
+.python_version
+data/
+notebooks/hsos-survey/Figures

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint
+        name: Markdownlint
+        files: \.(md|mdown|markdown)$
+        args: [
+            "--disable=MD013", # line-length
+            "--disable=MD033", # no-inline-html
+          ]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        name: codespell
+        description: Checks for common misspellings in text files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]

CITATION.cff

@@ -0,0 +1,37 @@
+cff-version: 1.2.0
+message: The results do not reflect the final estimations by the World Bank. Country borders or names do not necessarily reflect the World Bank Group’s official position. This map is for illustrative purposes and does not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries."
+title: "Support for the World Bank Syria Economic Monitor"
+authors:
+  - affiliation: World Bank
+    family-names: Sarva
+    given-names: Sahiti
+  - affiliation: World Bank
+    family-names: Stefanini Vicente
+    given-names: Gabriel
+    orcid: 0000-0001-6530-3780
+  - affiliation: World Bank
+    family-names: Marty
+    given-names: Robert
+    orcid: 0000-0002-3164-3813
+  - affiliation: World Bank
+    family-names: Chamorro
+    given-names: Andres
+  - affiliation: World Bank
+    family-names: Ruth Jones
+    given-names: Maria
+  - affiliation: World Bank
+    family-names: Istanto
+    given-names: Benny
+  - affiliation: World Bank
+    family-names: Krambeck
+    given-names: Holly
+keywords:
+  - Syria
+  - ACLED
+  - AIS
+  - Global Forest Watch
+  - NASA Black Marble
+  - Nighttime Lights
+repository-code: https://github.com/datapartnership/blackmarblepy/tree/v2024.1.0
+type: report
+version: v2024.1.0

README.md

@@ -12,25 +12,31 @@ The conflict in Syria has inflicted a devastating impact on the inhabitants and
 
 The Syria Economic Monitor team requested the WB Data Lab to explore use of alternative data to better understand changing trends in trade and economic activity, focusing on: port activity, surface cross-border transport routes, changes in observed agricultural production, observed nighttime lights, and reported conflict. The team, comprised of colleagues from the Global Operations Support Team (GOST), the Development Impact Monitoring and Evaluation team (DIME), the Development Data Partnership, and the WB Data Lab, worked with the Syria Economic Monitor team to explore use of alternative open and proprietary data sources to generate new data products that can be sustainably updated. With the datasets and methods provided, over time, the Syria team should be able to create a clearer picture of the state of the Syrian economy.
 
-### Data Goods
+### Results
 
 Datasets and methods used to generate insights for this project have been prepared as **Data Goods**. Data Goods are comprised of data, reproducible methods (code), documentation, and sample insights. Unlike a traditional data analysis, which results in a single-use report or visualization, Data Goods are designed to be re-used for future updates and projects, thereby building the capacity of the World Bank and partner organizations to quickly and effectively deliver complex data science solutions to pressing global challenges.
 
 ```{important}
 In February 2022, the *Syria Economic Monitor* team received a [Data Corps Strategic Brief](https://worldbankgroup-my.sharepoint.com/:b:/r/personal/hkrambeck_worldbank_org/Documents/00%20-%20Labs/%200%20SD%20Data%20Lab%20-%20Shared/Data%20Corps/Data%20Corps%20-%20Projects/2022-02%20DC%20Syria%20Economic%20Brief/Data%20Corps%20Strategic%20Brief%20-%20Syria%20Economic%20Report.pdf?csf=1&web=1&e=5kiAIp), of which the following working methodologies are a result and waiting peer-review.
 ```
 
-## Contents
+The following reports featured insights from our project’s data and analyses.
+
+- [Syria Economic Monitor, Spring 2022 : Lost Generation of Syrians](https://documents.worldbank.org/en/publication/documents-reports/documentdetail/099335506102250271/idu06190a00a0d128048450a4660ae3b937ae4bd)
+- [Syria Economic Monitor, Winter 2022/23: Syria’s Economy in Ruins after a Decade-long War](https://openknowledge.worldbank.org/entities/publication/74944b29-bdf4-47a6-9a8e-b1e8c83a5ff2)
+- [Syria Economic Monitor, Summer 2023 : The Economic Aftershocks of Large Earthquakes](hhttps://openknowledge.worldbank.org/entities/publication/45cbbf41-e0dc-4009-83ae-3c01162d7385)
+
+### Contents
 
 ```{tableofcontents}
 ```
 
-## Data
+### Data
 
-### Data Availability Statement
+#### Data Availability Statement
 
 Restrictions may apply to the data that support the findings of this study. Data received from the private sector through the Development Data Partnership are subject to the terms and conditions of the data license agreement and the "Official Use Only" data classification. These data are available upon request through the [Development Data Partnership](https://datapartnership.org). Licensing and access information for all other datasets are included in the documentation.
 
 ## License
 
-The repository is licensed under the [Mozilla Public License](https://www.mozilla.org/en-US/MPL).
+This project is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.

_static/custom.css

@@ -45,4 +45,4 @@ a.current.reference.internal {
 
 #pst-back-to-top {
 	background-color: #3eacad;
-}
+}

docs/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[[email protected]](mailto:[email protected])
+<[email protected]>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.