Use transport data/config files from message_ix_models

Author: khaeru

message_ix_models/model/transport/CHN_IND.py

@@ -6,7 +6,7 @@
 from iam_units import registry
 from item import historical  # type: ignore [import-not-found]
 
-from message_ix_models.util import private_data_path
+from message_ix_models.util import package_data_path
 
 UNITS = {
     "Population": (1.0e-6, None, "dimensionless"),
@@ -146,7 +146,7 @@ def get_chn_ind_pop():
         DataFrame containing population data for China and India.
     """
     # Read csv file
-    pop = pd.read_csv(private_data_path("transport", POP_FILE), header=1)
+    pop = pd.read_csv(package_data_path("transport", POP_FILE), header=1)
     # Drop irrelevant columns and rename when necessary
     pop = pop.drop(
         [x for x in pop.columns if x not in ["LOCATION", "Time", "Value"]],
@@ -184,7 +184,7 @@ def get_chn_ind_data(private_vehicles=False):
     for file, skip_footer in FILES.values():
         # Read excel sheet
         df_aux = pd.read_csv(
-            private_data_path("transport", file),
+            package_data_path("transport", file),
             skipfooter=skip_footer,
             header=2,
         )

message_ix_models/model/transport/cli.py

@@ -83,7 +83,7 @@ def export_emissions_factors(context, path_stem):
     """
     from datetime import datetime
 
-    from message_ix_models.util import private_data_path
+    from message_ix_models.util import package_data_path
 
     # List of techs
     techs = context.transport.spec.remove.set["technology"]
@@ -92,7 +92,7 @@ def export_emissions_factors(context, path_stem):
     scenario = context.get_scenario()
 
     # Output path
-    out_dir = private_data_path("transport", "emi")
+    out_dir = package_data_path("transport", "emi")
     out_dir.mkdir(exist_ok=True, parents=True)
 
     for name in ("emission_factor", "relation_activity"):

message_ix_models/model/transport/config.py

@@ -11,7 +11,7 @@
 from message_ix_models.project.ssp import SSP_2024, ssp_field
 from message_ix_models.project.transport_futures import SCENARIO as FUTURES_SCENARIO
 from message_ix_models.report.util import as_quantity
-from message_ix_models.util import identify_nodes, private_data_path
+from message_ix_models.util import identify_nodes, package_data_path
 from message_ix_models.util.config import ConfigHelper
 
 log = logging.getLogger(__name__)
@@ -353,7 +353,7 @@ def from_context(
         try:
             # Update with region-specific configuration
             config.read_file(
-                private_data_path("transport", context.model.regions, "config.yaml")
+                package_data_path("transport", context.model.regions, "config.yaml")
             )
         except FileNotFoundError as e:
             log.warning(e)

message_ix_models/model/transport/data.py

@@ -19,7 +19,7 @@
     make_matched_dfs,
     make_source_tech,
     merge_data,
-    private_data_path,
+    package_data_path,
     same_node,
 )
 from message_ix_models.util.ixmp import rename_dims
@@ -239,7 +239,7 @@ def __init__(self, source, source_kw):
 
         self.measure = source_kw.pop("measure")
         self.name, self._unit = self._name_unit[self.measure]
-        self.path = private_data_path("transport", f"iea-2017-t4-{self.measure}.csv")
+        self.path = package_data_path("transport", f"iea-2017-t4-{self.measure}.csv")
 
     def __call__(self):
         from genno.operator import load_file

message_ix_models/model/transport/emission.py

@@ -10,7 +10,7 @@
 from message_ix import make_df
 
 from message_ix_models import Context
-from message_ix_models.util import private_data_path
+from message_ix_models.util import package_data_path
 
 from .util import path_fallback
 
@@ -32,7 +32,7 @@ def get_emissions_data(context: Context) -> Dict[str, pd.DataFrame]:
 def get_intensity(context: Context) -> "AnyQuantity":
     """Load emissions intensity data from a file."""
     # FIXME use through the build computer
-    return load_file(private_data_path("transport", "fuel-emi-intensity.csv"))
+    return load_file(package_data_path("transport", "fuel-emi-intensity.csv"))
 
 
 def strip_emissions_data(scenario, context):

message_ix_models/model/transport/ikarus.py

@@ -22,7 +22,7 @@
     convert_units,
     make_matched_dfs,
     nodes_ex_world,
-    private_data_path,
+    package_data_path,
     same_node,
     same_time,
     series_of_pint_quantity,
@@ -164,7 +164,7 @@ def read_ikarus_data(occupancy, k_output, k_inv_cost):
     """
     # Open the input file using openpyxl
     wb = load_workbook(
-        private_data_path("transport", FILE), read_only=True, data_only=True
+        package_data_path("transport", FILE), read_only=True, data_only=True
     )
     # Open the 'updateTRPdata' sheet
     sheet = wb["updateTRPdata"]

message_ix_models/model/transport/ldv.py

@@ -27,7 +27,7 @@
     make_io,
     make_matched_dfs,
     merge_data,
-    private_data_path,
+    package_data_path,
     same_node,
 )
 from message_ix_models.util.ixmp import rename_dims
@@ -218,7 +218,7 @@ def read_USTIMES_MA3T(nodes: List[str], subdir=None) -> Mapping[str, "AnyQuantit
     particular context settings.
     """
     # Open workbook
-    path = private_data_path("transport", subdir or "", FILE)
+    path = package_data_path("transport", subdir or "", FILE)
     wb = load_workbook(path, read_only=True, data_only=True)
 
     # Tables
@@ -272,7 +272,7 @@ def read_USTIMES_MA3T_2(nodes: Any, subdir=None) -> Dict[str, "AnyQuantity"]:
     result = {}
     for name in "fix_cost", "fuel economy", "inv_cost":
         result[name] = load_file(
-            path=private_data_path(
+            path=package_data_path(
                 "transport", subdir or "", f"ldv-{name.replace(' ', '-')}.csv"
             ),
             dims=rename_dims(),

message_ix_models/model/transport/non_ldv.py

@@ -18,7 +18,7 @@
     make_io,
     make_matched_dfs,
     merge_data,
-    private_data_path,
+    package_data_path,
     same_node,
     same_time,
 )
@@ -105,7 +105,7 @@ def prepare_computer(c: Computer):
     )
     ####
     c.add(e[1] / "flow", "select", e[0], indexers=dict(flow="OTHER"), drop=True)
-    path = private_data_path("transport", context.regions, "energy-other.csv")
+    path = package_data_path("transport", context.regions, "energy-other.csv")
     kw = dict(header_comment=ENERGY_OTHER_HEADER)
     c.add("energy other csv", "write_report", e[1] / "flow", path=path, kwargs=kw)
 

message_ix_models/model/transport/roadmap.py

@@ -17,7 +17,7 @@
 import pandas as pd
 from plotnine import save_as_pdf_pages
 
-from message_ix_models.util import private_data_path
+from message_ix_models.util import package_data_path
 
 #: Name of the file containing the data.
 FILE = "RoadmapResults_2017.xlsx"
@@ -129,7 +129,7 @@ def get_roadmap_data(context, region=("Africa", "R11_AFR"), years=None, plot=Fal
             assert x in ALL_YEARS
     # Read xlsx file
     df = pd.read_excel(
-        private_data_path("transport", FILE), sheet_name="Model Results", header=0
+        package_data_path("transport", FILE), sheet_name="Model Results", header=0
     )
     df = df[(df["Year"].isin(years)) & (df["Roadmap_Region"] == region[0])].reset_index(
         drop=True

message_ix_models/model/transport/structure.py

@@ -5,7 +5,7 @@
 from message_ix_models import ScenarioInfo, Spec
 from message_ix_models.model import disutility
 from message_ix_models.model.structure import generate_set_elements, get_region_codes
-from message_ix_models.util import load_private_data, private_data_path
+from message_ix_models.util import load_package_data, package_data_path
 
 from .util import path_fallback
 
@@ -68,8 +68,8 @@ def make_spec(regions: str) -> Spec:
 
         # Load and store the data from the YAML file: either in a subdirectory for
         # context.model.regions, or the top-level data directory
-        path = path_fallback(regions, fn).relative_to(private_data_path())
-        tmp[name] = load_private_data(*path.parts)
+        path = path_fallback(regions, fn).relative_to(package_data_path())
+        tmp[name] = load_package_data(*path.parts)
 
     # Merge contents of technology.yaml into set.yaml
     sets.update(tmp.pop("set"))

message_ix_models/model/transport/util.py

@@ -9,7 +9,7 @@
 
 from message_ix_models import Context
 from message_ix_models.model.structure import get_codes
-from message_ix_models.util import private_data_path
+from message_ix_models.util import package_data_path
 
 if TYPE_CHECKING:
     import numbers
@@ -71,8 +71,8 @@ def path_fallback(context_or_regions: Union[Context, str], *parts) -> Path:
         regions = context_or_regions.model.regions
 
     candidates = (
-        private_data_path("transport", regions, *parts),
-        private_data_path("transport", *parts),
+        package_data_path("transport", regions, *parts),
+        package_data_path("transport", *parts),
     )
 
     for c in candidates:

message_ix_models/model/transport/workflow.py

@@ -7,7 +7,7 @@
 from genno import KeyExistsError
 
 from message_ix_models.project.ssp import SSP_2024
-from message_ix_models.util import private_data_path
+from message_ix_models.util import package_data_path
 
 if TYPE_CHECKING:
     import message_ix_models
@@ -44,7 +44,7 @@ def base_scenario_url(
 
     if method == "auto":
         # Load URL info from file
-        with open(private_data_path("transport", "base-scenario-url.json")) as f:
+        with open(package_data_path("transport", "base-scenario-url.json")) as f:
             info = json.load(f)
 
         # Identify a key that matches the settings on `config`

message_ix_models/project/navigate/__init__.py

@@ -15,14 +15,14 @@
 
 from message_ix_models.model.workflow import Config as WfConfig
 from message_ix_models.project.engage.workflow import PolicyConfig
-from message_ix_models.util import MESSAGE_DATA_PATH, as_codes
+from message_ix_models.util import MESSAGE_MODELS_PATH, as_codes
 
 log = logging.getLogger(__name__)
 
 ixmp.config.register(
     "navigate workflow dir",
     Path,
-    cast(Path, MESSAGE_DATA_PATH).parent.joinpath("navigate-workflow"),
+    cast(Path, MESSAGE_MODELS_PATH).parent.joinpath("navigate-workflow"),
 )