Skip to content

Commit

Permalink
Expand docs
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru committed Jul 26, 2024
1 parent 0d94447 commit a3b1273
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 1 deletion.
12 changes: 12 additions & 0 deletions doc/giz.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Gesellschaft für Internationale Zusammenarbeit (GIZ)
****************************************************

GIZ GmbH (`website <https://www.giz.de/en/>`_, lit. *Corporation for International Development*) is the main German development agency.
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.
This work mainly appears in the :mod:`.org` and :mod:`.proto` modules.

TUEWAS
======

- “Transport, Environment, Energy, and Water in Asia” is an “internal sector network” of GIZ.
- Website: https://tuewas-asia.org/
4 changes: 4 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,19 @@ They handle tasks including:

adb
estat
giz
iamc
ipcc
jrc
oica
org
proto

- :mod:`.adb`: :doc:`adb`
- :mod:`.estat`: :doc:`estat`
- :doc:`giz`
- :mod:`.iamc`: :doc:`iamc`
- :mod:`.ipcc`: :doc:`ipcc`
- :mod:`.jrc`: :doc:`jrc`
- :mod:`.oica`: :doc:`oica`
- :mod:`.org`: :doc:`org`
Expand Down
10 changes: 10 additions & 0 deletions doc/ipcc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@ Intergovernmental Panel on Climate Change (IPCC)
************************************************

.. include:: _api/transport_data.ipcc.rst

References
==========

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).
Since :mod:`transport_data` does not currently have a :mod:`.unfccc` module, they are included here.

- 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>`__).
- 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>`__).
- 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>`__).
3 changes: 2 additions & 1 deletion doc/roadmap.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Roadmap
*******

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.
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.
See also `transport-data/projects/1 <https://github.com/orgs/transport-data/projects/1>`_ on GitHub.
4 changes: 4 additions & 0 deletions doc/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ If used, annotations with these IDs **must** conform to the given requirements:

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

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

Codes
-----

Expand Down
1 change: 1 addition & 0 deletions doc/whatsnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ What's new
Next release
============

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

0 comments on commit a3b1273

Please sign in to comment.