plexos-plants

PLEXOS plant Command Line Interface

plexos-plants [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

-n, --name <name>

Job name. Default is “plexos-plants”.

-pt, --plexos_table <plexos_table>

Required Path to .csv PLEXOS table of bus locations (latitude, longitude) and capacity (MW). Note that capacity needs to be AC for wind and DC for solar.

-sc, --sc_table <sc_table>

Required Path to Supply Curve table .csv

-mym, --mymean_fpath <mymean_fpath>

Required Path to reV multi-year-mean output .h5 file

-cf, --cf_fpath <cf_fpath>

Required Path to reV annual Generation output .h5 file

-out, --out_dir <out_dir>

Required Directory to dump output files

-dp, --dist_percentile <dist_percentile>

Percentile to use to compute distance threshold using sc_gid to SubStation distance, by default 90

Default:

90

-dt, --dist_thresh_km <dist_thresh_km>

Optional absolute distance threshold in km that will override the dist_percentile input.

-lc, --lcoe_col <lcoe_col>

LCOE column to sort by, by default ‘total_lcoe’

Default:

'total_lcoe'

-lt, --lcoe_thresh <lcoe_thresh>

LCOE threshold multiplier, exclude sc_gids above threshold, by default 1.3

Default:

1.3

-pn, --plant_name_col <plant_name_col>

Column in plexos_table that has the plant name that should be used in the plexos output csv column headers.

-tt, --tech_tag <tech_tag>

Optional technology tag to include as a suffix in the plexos output csv column headers.

-tz, --timezone <timezone>

Timezone for output generation profiles. This is a string that will be passed to pytz.timezone() e.g. US/Pacific, US/Mountain, US/Central, US/Eastern, or UTC. For a list of all available timezones, see pytz.all_timezones

Default:

'UTC'

-mw, --max_workers <max_workers>

Number of workers to use for point and plant creation, 1 == serial, > 1 == parallel, None == parallel using all available cpus, by default None

--points_per_worker <points_per_worker>

Number of points to create on each worker, by default 400

Default:

400

--plants_per_worker <plants_per_worker>

Number of plants to identify on each worker, by default 40

Default:

40

-o, --offshore

Include offshore points, by default False

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

eagle

Eagle submission tool for PLEXOS aggregation.

plexos-plants eagle [OPTIONS]

Options

-a, --alloc <alloc>

Required Eagle allocation account name.

-wt, --walltime <walltime>

Eagle walltime request in hours. Default is 1.0

Default:

1.0

-l, --feature <feature>

Additional flags for SLURM job. Format is “–qos=high” or “–depend=[state:job_id]”. Default is None.

-sout, --stdout_path <stdout_path>

Subprocess standard output path. Default is in out_dir.