search

sustainableaviation / demandmap

✈️🌐 Map of Global Air Transport (with Future Demand)
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Create Mermaid Diagram of API Calls #8

Open michaelweinold opened 7 months ago

michaelweinold commented 7 months ago

Before we start writing Python code, we should know exactly what API calls we will need to make.

[!TIP] Remember: We want to know how many flights are scheduled between all airports worldwide. If this includes additional data on the type of airplane, that would be nice. Since we will likely never be given enough high-tier queries to get all flights for an entire year, we will need to approximate global air traffic through one week in winter and one week in summer.

To document the API query workflow, we should add a Mermaid diagram to the demandmap readme.md file. The different API calls in the diagram should link to the corresponding API documentation. Additional comments/description can be added as text at the end, perhaps by using footnotes or "[1],[2]"-style references.

You can use this diagram I made for the Brightway Documentation as a template.

michaelweinold commented 6 months ago

@dodedic, @arebe337 - is the diagram compatible with your latest script? If so, we can close the issue.

michaelweinold commented 5 months ago

@dodedic, please update the diagram in the readme by adding a color legend below. If you give me the ok, I can then close the issue.