UNFCCC_non-AnnexI_data/dodo.py

# define tasks for UNFCCC data repository
from doit import get_var
import os
import sys

# TODO: task for folder mapping

# create virtual environment
# def task_setup_venv():
#     """Create virtual environment"""
#     return {
#         'file_dep': ['requirements_dev.txt', 'setup.cfg', 'pyproject.toml'],
#         'actions': ['python3 -m venv venv',
#                     './venv/bin/pip install --upgrade pip wheel',
#                     #'./venv/bin/pip install -Ur unfccc_ghg_data/requirements.txt',
#                     './venv/bin/pip install --upgrade --upgrade-strategy '
#                     'eager -e .[dev]',
#                     'touch venv',],
#         'targets': ['venv'],
#         'verbosity': 2,
#     }

def task_in_venv():
    def in_venv():
        if sys.prefix == sys.base_prefix:
            raise ValueError("You need to run the code from the virtual environment.")

    return {
        'actions': [in_venv],
    }


# set UNFCCC_GHG_ROOT_PATH environment variable
def task_set_env():
    """
    Set the environment variable for the module so data is stored in the correct folders
    """
    def set_root_path():
        os.environ["UNFCCC_GHG_ROOT_PATH"] = "."

    return {
        'actions': [set_root_path],
    }


# Task to create the mapping files which map folder names to ISO 3-letter country codes
read_config_folder = {
    "folder": get_var('folder', None),
}

def task_map_folders():
    """
    Create or update the folder mapping in the given folder
    """
    return {
        'actions': [f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder={read_config_folder['folder']}"],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


# Tasks for getting submissions and downloading them
def task_update_bur():
    """ Update list of BUR submissions """
    return {
        'targets': ['downloaded_data/UNFCCC/submissions-bur.csv'],
        'actions': ['datalad run -m "Fetch BUR submissions" '
                    '-o downloaded_data/UNFCCC/submissions-bur.csv '
                    'python src/unfccc_ghg_data/unfccc_downloader/fetch_submissions_bur.py'],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_download_bur():
    """ Download BUR submissions """
    return {
        #'file_dep': ['downloaded_data/UNFCCC/submissions-bur.csv'],
        # deactivate file_dep fow now as it will always run fetch submissions
        # before download
        'actions': ['datalad run -m "Download BUR submissions" '
                    '-i downloaded_data/UNFCCC/submissions-bur.csv '
                    'python src/unfccc_ghg_data/unfccc_downloader/download_non-annexI.py --category=BUR',
                    f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder=downloaded_data/UNFCCC"
                    ],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_update_nc():
    """ Update list of NC submissions """
    return {
        'targets': ['downloaded_data/UNFCCC/submissions-nc.csv'],
        'actions': ['datalad run -m "Fetch NC submissions" '
                    '-o downloaded_data/UNFCCC/submissions-nc.csv '
                    'python src/unfccc_ghg_data/unfccc_downloader/fetch_submissions_nc.py'],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_download_nc():
    """ Download NC submissions """
    return {
        #'file_dep': ['downloaded_data/UNFCCC/submissions-nc.csv'],
        # deactivate file_dep fow now as it will always run fetch submissions
        # before download
        'actions': ['datalad run -m "Download NC submissions" '
                    '-i downloaded_data/UNFCCC/submissions-nc.csv '
                    'python src/unfccc_ghg_data/unfccc_downloader/download_non-annexI.py --category=NC',
                    f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder=downloaded_data/UNFCCC"
                    ],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }

# annexI data: one update call for all data types (as they are on one page)
# but for each year separately.
# downloading is per year and
update_aI_config = {
    "year": get_var('year', None),
    "category": get_var('category', None),
}


def task_update_annexi():
    """ Update list of AnnexI submissions """
    return {
        'targets': [f"downloaded_data/UNFCCC/submissions-annexI_{update_aI_config['year']}.csv"],
        'actions': [f"datalad run -m 'Fetch AnnexI submissions for {update_aI_config['year']}' "
                    "--explicit "
                    f"-o downloaded_data/UNFCCC/submissions-annexI_{update_aI_config['year']}.csv "
                    f"python src/unfccc_ghg_data/unfccc_downloader/fetch_submissions_annexI.py "
                    f"--year={update_aI_config['year']}"],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_download_annexi():
    """ Download AnnexI submissions """
    return {
        #'file_dep': ['downloaded_data/UNFCCC/submissions-nc.csv'],
        # deactivate file_dep fow now as it will always run fetch submissions
        # before download
        'actions': [f"datalad run -m 'Download AnnexI submissions for "
                    f"{update_aI_config['category']}{update_aI_config['year']}' "
                    f"-i downloaded_data/UNFCCC/submissions-annexI_{update_aI_config['year']}.csv "
                    f"python src/unfccc_ghg_data/unfccc_downloader/download_annexI.py "
                    f"--category={update_aI_config['category']} --year={update_aI_config['year']}",
                    f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder=downloaded_data/UNFCCC"
                    ],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_download_ndc():
    """ Download NDC submissions """
    return {
        'actions': ['datalad run -m "Download NDC submissions" '
                    'python src/unfccc_ghg_data/unfccc_downloader/download_ndc.py',
                    f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder=downloaded_data/UNFCCC"
                    ],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


# read UNFCCC submissions.
# datalad run is called from within the read_UNFCCC_submission.py script
read_config = {
    "country": get_var('country', None),
    "submission": get_var('submission', None),
}


# TODO: make individual task for non-UNFCCC submissions
def task_read_unfccc_submission():
    """ Read submission for a country (if code exists) (not for CRF)"""
    return {
        'actions': [f"python src/unfccc_ghg_data/unfccc_reader/read_UNFCCC_submission.py "
                    f"--country={read_config['country']} --submission={read_config['submission']}",
                    f"python src/unfccc_ghg_data/helper/folder_mapping.py "
                    f"--folder=extracted_data/UNFCCC"
                    ],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


# read UNFCCC submissions.
# datalad run is called from within the read_UNFCCC_submission.py script
read_config_crf = {
    "country": get_var('country', None),
    "submission_year": get_var('submission_year', None),
    "submission_date": get_var('submission_date', None),
    "re_read": get_var('re_read', False),
    "countries": get_var('countries', None),
    "data_year": get_var('data_year', None),
    "totest": get_var('totest', None),
}

def task_read_unfccc_crf_submission():
    """ Read CRF submission for a country """
    actions = [
        f"python src/unfccc_ghg_data/unfccc_crf_reader"
        f"/read_unfccc_crf_submission_datalad.py "
        f"--country={read_config_crf['country']} "
        f"--submission_year={read_config_crf['submission_year']} "
        f"--submission_date={read_config_crf['submission_date']} ",
        f"python src/unfccc_ghg_data/helper/folder_mapping.py "
        f"--folder=extracted_data/UNFCCC"
        ]
    if read_config_crf["re_read"] == "True":
        actions[0] = actions[0] + " --re_read"
    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_read_new_unfccc_crf_for_year():
    """ Read CRF submission for all countries for given submission year. by default only reads
    data not present yet. Only reads the latest updated submission for each country."""
    actions = [f"python src/unfccc_ghg_data/unfccc_crf_reader"
               f"/read_new_unfccc_crf_for_year_datalad.py "
               f"--submission_year={read_config_crf['submission_year']} ",
               f"python src/unfccc_ghg_data/helper/folder_mapping.py "
               f"--folder=extracted_data/UNFCCC"
               ]
    # specifying countries is currently disabled duo to problems with command line
    # list arguments
    #if read_config_crf["countries"] is not None:
    #        actions[0] = actions[0] + f"--countries={read_config_crf['countries']} "
    if read_config_crf["re_read"] == "True":
        actions[0] = actions[0] + " --re_read"
    return {
        #'basename': "Read_CRF_year",
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_test_read_unfccc_crf_for_year():
    """ Read CRF submission for all countries for given submission year. by default only reads
    data not present yet. Only reads the latest updated submission for each country."""
    actions = [f"python "
               f"src/unfccc_ghg_data/unfccc_crf_reader"
               f"/test_read_unfccc_crf_for_year.py "
               f"--submission_year={read_config_crf['submission_year']} "
               f"--country={read_config_crf['country']} "
               ]
    if read_config_crf["totest"] == "True":
        actions[0] = actions[0] + " --totest"

    if read_config_crf["data_year"] is not None:
        actions[0] = actions[0] + f"--data_year={read_config_crf['data_year']} "
    return {
        #'basename': "Read_CRF_year",
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_compile_raw_unfccc_crf_for_year():
    """ Read CRF submission for all countries for given submission year. by default only reads
    data not present yet. Only reads the latest updated submission for each country."""
    actions = [f"python "
               f"src/unfccc_ghg_data/unfccc_crf_reader/crf_raw_for_year.py "
               f"--submission_year={read_config_crf['submission_year']} "
               ]
    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }

# tasks for DI reader
# datalad run is called from within the read_unfccc_di_for_country.py script
read_config_di = {
    "country": get_var('country', None),
    "date": get_var('date', None),
    "annexI": get_var('annexI', False),
    #"countries": get_var('countries', None),
}

def task_read_unfccc_di_for_country():
    """ Read DI data for a country """
    actions = [
        f"python "
        f"src/unfccc_ghg_data/unfccc_di_reader/read_unfccc_di_for_country_datalad.py "
        f"--country={read_config_di['country']}",
        f"python src/unfccc_ghg_data/helper/folder_mapping.py "
        f"--folder=extracted_data/UNFCCC"
        ]
    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }

def task_process_unfccc_di_for_country():
    """ Process DI data for a country """
    actions = [
        f"python "
        f"src/unfccc_ghg_data/unfccc_di_reader/process_unfccc_di_for_country_datalad"
        f".py "
        f"--country={read_config_di['country']} --date={read_config_di['date']}",
        f"python src/unfccc_ghg_data/helper/folder_mapping.py "
        f"--folder=extracted_data/UNFCCC"
        ]
    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }

def task_read_unfccc_di_for_country_group():
    """ Read DI data for a country group """
    actions = [
        f"python "
        f"src/unfccc_ghg_data/unfccc_di_reader/read_unfccc_di_for_country_group_datalad"
        f".py",
        f"python src/unfccc_ghg_data/helper/folder_mapping.py "
        f"--folder=extracted_data/UNFCCC"
        ]
    if read_config_di["annexI"] == "True":
        actions[0] = actions[0] + " --annexI"

    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }


def task_process_unfccc_di_for_country_group():
    """ Process DI data for a country group """
    actions = [
        f"python "
        f"src/unfccc_ghg_data/unfccc_di_reader"
        f"/process_unfccc_di_for_country_group_datalad"
        f".py",
        ]
    if read_config_di["annexI"] == "True":
        actions[0] = actions[0] + " --annexI"
    if read_config_di["date"] is not None:
        actions[0] = actions[0] + f" --date={read_config_di['date']}"

    return {
        'actions': actions,
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }

# general tasks
def task_country_info():
    """ Print information on submissions and datasets
    available for given country"""
    return {
        'actions': [f"python src/unfccc_ghg_data/helper/country_info.py "
                    f"--country={read_config['country']}"],
        'task_dep': ['set_env'],
        'verbosity': 2,
        'setup': ['in_venv'],
    }