Skip to content

Commit

Permalink
Add directional regions to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhuppmann committed Dec 18, 2024
1 parent b40da8f commit 117012d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/user_guide/region.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ Regions can have attributes, for example a description or ISO3-codes. If the att
`iso3_codes` is provided, the item(s) are validated against a list of valid codes taken
from the `pycountry <https://github.com/flyingcircusio/pycountry>`_ package.

Directional data
----------------

For reporting of directional data (e.g., trade flows), "directional regions" can be
defined using a *>* separator. The region before the separator is the *origin*,
the region after the separator is the *destination*.

.. code:: yaml
- Trade Connections:
- China>Europe
Both the origin and destination regions must be defined in the region codelist.

Common regions
--------------

Expand Down

0 comments on commit 117012d

Please sign in to comment.