Return log level of the storage Backend, if any. Region ( list of str, optional) – Only return data for region(s) in this list.Įxport_all_runs ( boolean, optional) – Export all existing model+scenario run combinations. Unit ( list of str, optional) – Only return data for unit name(s) in this list. Variable ( list of str, optional) – Only return data for variable name(s) in this list. Scenario ( str, optional) – Only return data for this scenario name. Model ( str, optional) – Only return data for this model name. Result file will contain the following columns:ĭefault ( bool, optional) – True to include only TimeSeries versions marked as default. Parametersįile name to export data to must have the suffix ‘.csv’. Refer TimeSeries.add_timeseries() about adding time series data. Models ( str or list of str) – Model(s) nameĪccess ( str, optional) – Access type - view or editīool or dict of bool export_timeseries_data ( path : PathLike, default : bool = True, model : Optional = None, scenario : Optional = None, variable = None, unit = None, region = None, export_all_runs : bool = False ) → None Įxport time series data to CSV file across multiple TimeSeries. User and timestamp are appended automatically.Ĭheck_access ( user : str, models : Union ], access : str = 'view' ) → Union ] Ĭheck access to specific models. ‘common’, ‘month’, etc).ĭuration ( float) – Duration of timeslice as fraction of year.Īdd_unit ( unit : str, comment : str = 'None' ) → None Ĭomment ( str, optional) – Annotation describing the unit or why it was added. Name ( str) – Unique name of the timeslice.Ĭategory ( str) – Timeslice category (e.g. See timeslices() for a detailed description of timeslices. Mapped_to ( str) – Name of the region to which the synonym should be mapped.Īdd_timeslice ( name : str, category : str, duration : float ) → None ĭefine a subannual timeslice including a category and duration. Region ( str) – Name of the region synonym. When adding timeseries data using the synonym in the region column, it will be Hierarchy ( str) – Hierarchy level of the region (e.g., country, R11, basin)Īdd_region_synonym ( region : str, mapped_to : str ) → None Parent ( str, default 'World') – Assign a ‘parent’ region. Use regions() first to check, andĬonsider calling add_region_synonym() instead. On a Platform backed by a shared database, a region may alreadyĮxist with a different spelling. These methods can be called like normal Platform methods, e.g.: OPTIONAL: (Re-)open database connection(s).ī_meta(names, .)ī_doc(domain, docs)ī_meta(meta, model, .) Retrieve all metadata attached to a specific target.ī_scenario_names() The following backend methods are available via Platform too:ī_model_name(name)ī_scenario_name(name)ī_doc(domain)ī_meta(model, .) Return all units defined on the Platform. Set log level for the Platform and its storage Backend. Return information about TimeSeries and Scenarios on the Platform. Return all regions defined time series data, including synonyms. See JDBCBackend.ĭefine a region including a hierarchy level and a 'parent' region. ‘jdbc’ corresponds to the built-in JDBCBackend īackend_args – Keyword arguments to specific to the backend. Name ( str) – Name of a specific configured backend.īackend ( 'jdbc') – Storage backend type. Scenario objects tied to a single Platform to move data between platforms, The Platform parameters control these components. Run, via Scenario.solve(), on the data stored in the Platform. One or more model(s) codes in Python or other languages or frameworks that Platform ( name : Optional = None, backend : Optional = None, ** backend_args ) Ī back end for storing data such as model inputs and outputs. TimeSeries(mp, model, scenario)Ĭollection of data in time series format. The ix modeling platform application programming interface (API) is organized around three classes:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |