generated from worldbank/template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 4d1bef9
Showing
35 changed files
with
3,202 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
NASA_API_KEY = <YOUR_NASA_API_KEY> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
name: Bug Report | ||
about: Use to report a bug | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
## 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. | ||
|
||
#### Environment | ||
|
||
- **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] | ||
|
||
### Additional Context | ||
|
||
Provide any additional context or information about the bug. | ||
|
||
### Possible Fix | ||
|
||
If you have suggestions for a fix, please describe them here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "pip" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Publish to GitHub Pages | ||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build-book: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.11 | ||
cache: "pip" | ||
- name: Install Dependencies | ||
run: | | ||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
if [ -f pyproject.toml ]; then pip install ".[docs]"; fi | ||
- name: Build Juputer Book Documentation | ||
run: | | ||
jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
if: github.ref == 'refs/heads/main' && job.status == 'success' | ||
with: | ||
path: "_build/html" | ||
|
||
deploy-book: | ||
needs: build-book | ||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI | ||
|
||
on: | ||
push: | ||
tags: | ||
- '*' | ||
|
||
jobs: | ||
build: | ||
name: Build distribution 📦 | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.x" | ||
- name: Install pypa/build | ||
run: >- | ||
python3 -m | ||
pip install | ||
build | ||
--user | ||
- name: Build a binary wheel and a source tarball | ||
run: python3 -m build | ||
- name: Store the distribution packages | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
|
||
publish-to-pypi: | ||
name: >- | ||
Publish Python 🐍 distribution 📦 to PyPI | ||
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes | ||
needs: | ||
- build | ||
runs-on: ubuntu-latest | ||
environment: | ||
name: pypi | ||
url: https://pypi.org/p/wb-template # Replace <package-name> with your PyPI project name | ||
permissions: | ||
id-token: write # IMPORTANT: mandatory for trusted publishing | ||
|
||
steps: | ||
- name: Download all the dists | ||
uses: actions/download-artifact@v4 | ||
with: | ||
name: python-package-distributions | ||
path: dist/ | ||
- name: Publish distribution 📦 to PyPI | ||
uses: pypa/gh-action-pypi-publish@release/v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# DotEnv configuration | ||
.env | ||
|
||
# Database | ||
*.db | ||
*.rdb | ||
|
||
# Pycharm | ||
.idea | ||
|
||
# VS Code | ||
.vscode/ | ||
|
||
# Spyder | ||
.spyproject/ | ||
|
||
# Jupyter NB Checkpoints | ||
.ipynb_checkpoints/ | ||
|
||
# Mac OS-specific storage files | ||
.DS_Store | ||
|
||
# vim | ||
*.swp | ||
*.swo | ||
|
||
# Mypy cache | ||
.mypy_cache/ | ||
|
||
# Jupyter Book | ||
_build/ | ||
|
||
# python-dotenv | ||
.env | ||
|
||
# setuptools-scm/ | ||
src/*/_version.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.6.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.41.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.3.0 | ||
hooks: | ||
- id: codespell | ||
name: codespell | ||
description: Checks for common misspellings in text files | ||
- repo: https://github.com/astral-sh/ruff-pre-commit | ||
rev: v0.6.5 | ||
hooks: | ||
- id: ruff | ||
types_or: [python, pyi, jupyter] | ||
args: [--fix] | ||
- id: ruff-format | ||
types_or: [python, pyi, jupyter] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
cff-version: 1.2.0 | ||
message: "Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do 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: "World Bank Data Lab Project Template" | ||
authors: | ||
- affiliation: World Bank | ||
family-names: Stefanini Vicente | ||
given-names: Gabriel | ||
orcid: https://orcid.org/0000-0001-6530-3780 | ||
keywords: | ||
- Open Science | ||
repository-code: https://github.com/worldbank/template/tree/main |
Oops, something went wrong.