Skip to content

Commit a3b1273

Browse files
committed
Expand docs
1 parent 0d94447 commit a3b1273

File tree

6 files changed

+33
-1
lines changed

6 files changed

+33
-1
lines changed

doc/giz.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Gesellschaft für Internationale Zusammenarbeit (GIZ)
2+
****************************************************
3+
4+
GIZ GmbH (`website <https://www.giz.de/en/>`_, lit. *Corporation for International Development*) is the main German development agency.
5+
It is not currently a direct provider of (meta)data through TDC, but its members initiated what is now the TDCI and support its activities, including development of this :mod:`.transport_data` package.
6+
This work mainly appears in the :mod:`.org` and :mod:`.proto` modules.
7+
8+
TUEWAS
9+
======
10+
11+
- “Transport, Environment, Energy, and Water in Asia” is an “internal sector network” of GIZ.
12+
- Website: https://tuewas-asia.org/

doc/index.rst

+4
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,19 @@ They handle tasks including:
5353

5454
adb
5555
estat
56+
giz
5657
iamc
58+
ipcc
5759
jrc
5860
oica
5961
org
6062
proto
6163

6264
- :mod:`.adb`: :doc:`adb`
6365
- :mod:`.estat`: :doc:`estat`
66+
- :doc:`giz`
6467
- :mod:`.iamc`: :doc:`iamc`
68+
- :mod:`.ipcc`: :doc:`ipcc`
6569
- :mod:`.jrc`: :doc:`jrc`
6670
- :mod:`.oica`: :doc:`oica`
6771
- :mod:`.org`: :doc:`org`

doc/ipcc.rst

+10
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,13 @@ Intergovernmental Panel on Climate Change (IPCC)
22
************************************************
33

44
.. include:: _api/transport_data.ipcc.rst
5+
6+
References
7+
==========
8+
9+
Some of these references are to documents or webpages authored not by the IPCC *per se*, but by individuals or groups connected to the United Nations Framework Convention on Climate Change (UN FCCC).
10+
Since :mod:`transport_data` does not currently have a :mod:`.unfccc` module, they are included here.
11+
12+
- 2006 Guidelines for National Greenhouse Gas Inventories (`HTML <https://www.ipcc-nggip.iges.or.jp/public/2006gl/>`__) — Volume 2: Energy (`HTML <https://www.ipcc-nggip.iges.or.jp/public/2006gl/vol2.html>`__) — Chapter 3: Mobile Combustion (`PDF (en) <https://www.ipcc-nggip.iges.or.jp/public/2006gl/pdf/2_Volume2/V2_3_Ch3_Mobile_Combustion.pdf>`__).
13+
- 2023-01 Technical handbook for developing country Parties on Preparing for implementation of the enhanced transparency framework [ETF] under the Paris Agreement (`HTML <https://unfccc.int/process-and-meetings/transparency-and-reporting/support-for-developing-countries/consultative-group-of-experts/enhanced-transparency-framework-technical-material#Technical-Handbook>`__, `PDF (en) <https://unfccc.int/sites/default/files/resource/ETF%20Handbook-Edt2_EN.pdf>`__).
14+
- 2024-01-24 Compendium on Greenhouse Gas Baselines and Monitoring Passenger and Freight Transport (`HTML <https://unfccc.int/documents/636821>`__, `PDF (en) <https://unfccc.int/sites/default/files/resource/UNFCCC Compendium Transport Revised.pdf>`__).

doc/roadmap.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Roadmap
22
*******
33

4-
This page will give a longer-term overview of future development of :mod:`transport_data`, focused on the tools in this package, but with relevant details about the broader TDC and TDCI.
4+
This page gives a medium- and long-term overview of future development of :mod:`transport_data`, focused on the tools in this package, but with relevant details about the broader TDC and TDCI.
5+
See also `transport-data/projects/1 <https://github.com/orgs/transport-data/projects/1>`_ on GitHub.

doc/standards.rst

+4
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,10 @@ If used, annotations with these IDs **must** conform to the given requirements:
129129

130130
The function :func:`.anno_generated` generates such an annotation and **should** be called on all objects created in this package.
131131

132+
``preferred-unit``
133+
Especially for :class:`.Concept` in :class:`.ConceptScheme`, the preferred units of measurement if the concept is used as a measure.
134+
These correspond to the well-known SDMX concept and attribute ``Concept=SDMX:CROSS_DOMAIN_CONCEPTS(2.0).UNIT_MEASURE``.
135+
132136
Codes
133137
-----
134138

doc/whatsnew.rst

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ What's new
44
Next release
55
============
66

7+
- Add :mod:`.ipcc` (:doc:`ipcc`) module (:issue:`15`, :pull:`21`).
78
- Add :doc:`standards` and :doc:`roadmap` documentation pages (:pull:`9`).
89
- Adjust :mod:`.adb` for changes in data format in the 2024-05-20 edition of the ATO National Database (:pull:`20`, :issue:`18`).
910
Document the :ref:`current file format <ato-format>` that the code supports.

0 commit comments

Comments
 (0)