Skip to content

Commit

Permalink
Cleaned Up Lab Template
Browse files Browse the repository at this point in the history
  • Loading branch information
Holly-Transport committed Sep 26, 2024
1 parent f0399a6 commit 659a48e
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 78 deletions.
34 changes: 14 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,34 @@

## Assignment

The Red Sea shipping crisis is a global crisis that began in October 2023, when missile attacks on ships and tankers traversing the Red Sea caused hundreds of vessels to avoid the Suez Canal. The attacks are concentrated near the Bab al-Mandab Strait, a 20-mile-wide chokepoint for maritime traffic.
The Red Sea shipping crisis is a global crisis that began in October 2023, when missile attacks on ships and tankers traversing the Red Sea caused hundreds of vessels to avoid the Suez Canal. The attacks are concentrated near the Bab al-Mandab Strait, a 20-mile-wide chokepoint for maritime traffic. The World Bank Country Economics teams in Egypt, Yemen, and Djibouti seek to monitor the status and impacts of the crisis on their respective and regional economies.

The World Bank Country Economics teams in Egypt, Yemen, and Djibouti seek to monitor the status and impacts of the crisis on their respective and regional economies. To support these efforts, a Bank team comprised of colleagues from the Data Lab and the Geospatial Operations Support Team (GOST) are using a combinat

## Data

Most of the data science products in thie repository are derived using maritime Automatic Identification System (AIS) data pulled from the [IMF PortWatch](https://portwatch.imf.org/) system and from the [UN Committee of Experts on Big Data and Data Science for Official Statistics](https://unstats.un.org/bigdata/task-teams/ais/index.cshtml), as well as conflict statistics provided by the [Armed Conflict Location and Event Data project](https://acleddata.com/).

## Reusable Data Science Products
## Contents

The following data products have been prepared:
```{tableofcontents}
* **Maritime Choke Point Trends Monitor** for the Suez Canal, Bab el-Mandreb Straight, and the Cape of Good Hope
```

* **Port Call Trends Monitor** for the following ports: Aden, Al Ahmadi, Al Aqabah, Al Mukalla, As Suways, Djibouti, Duba. Duba Bulk Plant Tanker Terminal, El-Adabiya, Jiddah, Jiddah Oil, King Fahd Port, North Ain Sukhna Port, Rabigh, Safaga, and Yanbu
##

* **Spillover Monitor** for trade arriving in ports in Egypt, Djibouti, and Yemen
## Data

* **Missing Ships Estimator** for ships that may have disabled their transponders (forthcoming)
Most of the data science products in thie repository are derived using maritime Automatic Identification System (AIS) data pulled from the [IMF PortWatch](https://portwatch.imf.org/) system and from the [UN Committee of Experts on Big Data and Data Science for Official Statistics](https://unstats.un.org/bigdata/task-teams/ais/index.cshtml), as well as conflict statistics provided by the [Armed Conflict Location and Event Data project](https://acleddata.com/).

* **Conflict Location and Trends Monitor** derived from ACLED data
Additional details about each dataset—such as licensing, update frequency, and access instructions—are provided within the respective data products.

* [**Tourism Trends Monitor**](notebooks/mobility/README.md) for Egypt's Red Sea Riviera through OpenStreetMap point of interest visits using GPS mobility data
#### Data Availability Statement

Time and resources pending, the team may also investigate datasets and methods for monitoring ancillary air cargo trends.
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.

## Insights and Indicators

The team is combining these data products to prepare high-level analytics and indicators, such as:
## License

* Combined conflict and maritime traffic diversion trends analysis
* Combined maritime traffic diversion and global shipping price trends analysis
This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.


## License
## Code of Conduct

This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.
The World Bank Data Lab <span style="color:#3EACAD">template</span> used to create this project maintains a [Code of Conduct](docs/CODE_OF_CONDUCT.md) to ensure an inclusive and respectful environment for everyone. Please adhere to it in all interactions within our community.
43 changes: 43 additions & 0 deletions docs/2-analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Analytics: Introduction

All Data Lab analytics include information on data sources, as well as original code and documentation. All analytics are presented in a web book format, per the following outline:

1. **Overview**

Summary of the analytical challenge.



2. **Data Description**
Everything a user would need to access and use the data that supports the analysis. For each source, we include:

- Description

- License

- Frequency of Access

- Access Instructions

- Point of Contact


3. **Methodology**
All analytses include step-by-step directions, code snippets, links to complete code, and notes on any critical dependencies. The user should be able to fully understand how the analytical results were achieved and be able to replicate them by following the methodology.



4. **Findings**

This section includes initial results, including statistics, graphs, and maps to illustrate findings.



5. **Limitations**

It is critical that all analyses are accompanied by a detailed description of limitations of the data and methodology for interpreting or reproducing results.



6. **References and Works Cited**
13 changes: 0 additions & 13 deletions docs/2-data.md

This file was deleted.

17 changes: 17 additions & 0 deletions docs/3-add-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Additional Resources

**Project Data**

Official-Use-Only original and derived datasets used in the project analytics are made available only to the project team. To request access, World Bank staff can write: [email protected]. Open datasets can be made available thorugh the World Bank's [open data catalog](https://datacatalog.worldbank.org/), at the request of the project team.

* [Project SharePoint](https://worldbankgroup.sharepoint.com/:f:/t/DevelopmentDataPartnershipCommunity-WBGroup/EoPKGdniEgNOsFM15KKAipAB1Zt35TWLhfnS51oSwvuJRQ)

**Project Data Visualiztaions**

For some projects, additional static visualizations are created to support presentation and publication. To request access, World Bank staff can write: [email protected].

* *Project SharePoint Link (if applicable)*

**Other Resources**

​ Additional links or resources are sometimes provided to supplement analytical work.
31 changes: 0 additions & 31 deletions docs/4-sample-insights-and-ind.md

This file was deleted.

20 changes: 6 additions & 14 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ parts:
- caption: Introduction to Data Goods
chapters:
- file: docs/1-intro-to-data-lab.md
- caption: Data
- caption: Analytics
chapters:
- file: docs/2-data
- caption: Reusable Data Products
- file: docs/2-analytics
chapters:
- file: notebooks/README
- file: notebooks/chokepoints/README
Expand Down Expand Up @@ -36,16 +35,9 @@ parts:
chapters:
- file: notebooks/indicators/conflict-and-trade.ipynb
- file: notebooks/houthis/houthis-tax.ipynb
- caption: Acknowledgements
chapters:
- file: docs/6-team
- caption: Additional Resources
chapters:
- url: https://datapartnership.org
title: Development Data Partnership
- url: https://wbdatalab.org
title: World Bank Data Lab
- url: https://www.worldbank.org/en/about/unit/unit-dec
title: World Bank DEC
- url: https://www.worldbank.org/en/research/dime
title: World Bank DIME
- file: docs/3-add-resources
- caption: Acknowledgements
chapters:
- file: docs/6-team

0 comments on commit 659a48e

Please sign in to comment.