flexvalue.cli

Copyright 2021 Recurve Analytics, Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

flexvalue

flexvalue [OPTIONS] COMMAND [ARGS]...

get-results

flexvalue get-results [OPTIONS]

Options

--project-info-file <project_info_file>

Filepath to the project information file that is used to calculate results

--database-type <database_type>

One of ‘postgresql’, ‘bigquery’, or ‘sqlite’

--host <host>

The host for the postgresql database to which you are connecting.

--port <port>

The port for the postgresql database to which you are connecting.

--user <user>

The user for the postgresql database to which you are connecting.

--password <password>

The password for the postgresql database to which you are connecting.

--database <database>

The database for the postgresql database to which you are connecting.

--elec-av-costs-table <elec_av_costs_table>

Used when –database-type is bigquery. Specifies the electric avoided costs table. Must specify the dataset and the google project (if different than the –project argument).

--elec-load-shape-table <elec_load_shape_table>

Used when –database-type is bigquery. Specifies the electric load shape table. Must specify the dataset and the google project (if different than the –project argument).

--gas-av-costs-table <gas_av_costs_table>

Used when –database-type is bigquery. Specifies the gas avoided costs table. Must specify the dataset and the google project (if different than the –project argument).

--therms-profiles-table <therms_profiles_table>

Used when –database-type is bigquery. Specifies the therms profiles table. Must specify the dataset and the google project (if different than the –project argument).

--project-info-table <project_info_table>

Used when –database-type is bigquery. Specifies the table containing the project information. Must specify the dataset and the google project (if different than the –project argument).

--metered-load-shape-table <metered_load_shape_table>

Used when –database-type is bigquery. Specifies the metered load shape table. Must specify the dataset and the google project (if different than the –project argument).

--project <project>

Used when –database-type is bigquery. Specifies the google project.

--output-table <output_table>

The database table to write output to. This table gets overwritten (not appended to). Must specify the dataset and the google project (if different than the –project argument).

--separate-output-tables

Create two output tables, one for electric benefits and one for gas.

--electric-output-table <electric_output_table>

The database table to write electric output to, when –separate-output-tables=True. This table gets overwritten (not appended to). Must specify the dataset and the google project (if different than the –project argument).

--gas-output-table <gas_output_table>

The database table to write gas output to, when –separate-output-tables=True. This table gets overwritten (not appended to). Must specify the dataset and the google project (if different than the –project argument).

--config-file <config_file>

Path to the toml configuration file.

--elec-av-costs-file <elec_av_costs_file>

Filepath to the electric avoided costs. Used when –database-type is not BigQuery to load this data into the database from a file.

--gas-av-costs-file <gas_av_costs_file>

Filepath to the gas avoided costs. Used when –database-type is not BigQuery to load this data into the database from a file.

--elec-load-shape-file <elec_load_shape_file>

Filepath to the hourly electric load shape file. Used when –database-type is not BigQuery to load this data into the database from a file.

--therms-profiles-file <therms_profiles_file>

Filepath to the therms profiles file. Used when –database-type is not BigQuery to load this data into the database from a file.

--metered-load-shape-file <metered_load_shape_file>

Filepath to the hourly metered load shape file. Used when –database-type is not BigQuery to load this data into the database from a file.

--aggregation-columns <aggregation_columns>

Comma-separated list of field names on which to aggregate the query.

--reset-elec-load-shape

Reset the data in the electric load shape table. This restores it to its contents prior to running FLEXvalue.

--reset-elec-av-costs

Reset the data in the electric avoided costs table. This restores it to its contents prior to running FLEXvalue.

--reset-therms-profiles

Reset the data in the therms profiles table. This restores it to its contents prior to running FLEXvalue.

--reset-gas-av-costs

Reset the data in the gas avoided costs table. This restores it to its contents prior to running FLEXvalue.

--process-elec-load-shape

Process (load/transform) the electric load shape data.

--process-elec-av-costs

Process (load/transform) the electric avoided costs data.

--process-therms-profiles

Process (load/transform) the therms profiles table.

--process-gas-av-costs

Process (load/transform) the gas avoided costs data.

--process-metered-load-shape

Process (load/transform) the metered load shape data.

--elec-components <elec_components>

Comma-separated list of electric avoided cost component field names

--gas-components <gas_components>

Comma-separated list of electric avoided cost component field names

--elec-addl-fields <elec_addl_fields>

Comma-separated list of additional fields from electric data to include in output

--gas-addl-fields <gas_addl_fields>

Comma-separated list of additional fields from gas data to include in output

--use-value-curve-name-for-join

Specifies that the ACC and project info tables you are using have multiple curves in them, and that FLEXvalue should join based on the curve names.