reVX
0.3.54
Home page
Installation and Usage
Installation
Recommended Citation
Command Line Tools
Examples
Resource Planning Model (RPM)
reV-RPM CLI
RPM sub-package
Regional Energy Deployment System (ReEDS)
reV-ReEDS CLI
ReEDS sub-package
reVX Setbacks
Computing setbacks for CONUS
Ordinance database
Config file setup
Execution
Merging
Advanced Topics
Partial Setbacks
Writing directly to HDF5 files
Feature-specific generic multipliers
Custom setbacks computations
Batched execution
Job Status
reVX LCP
H5 Layer File Creation
Masks
Layer Creation Configuration File
Required Keys
Optional Keys
Action Keys
Layer Creation Config File Examples
Running the Layer Creator
CONUS (Onshore) Example
Costs
Reinforced Transmission
Key assumptions under this approach:
Offshore Least Cost Paths
Nomenclature Note
Offshore Workflow
Offshore Examples
API reference
reVX.cli
reVX.config
reVX.config.least_cost_xmission
reVX.config.least_cost_xmission.DryCostCreatorConfig
reVX.config.least_cost_xmission.LeastCostPathsConfig
reVX.config.least_cost_xmission.LeastCostXmissionConfig
reVX.config.offshore
reVX.config.offshore.AssemblyAreasConfig
reVX.config.offshore.DistToPortsConfig
reVX.config.offshore.OffshoreInputsConfig
reVX.config.reeds
reVX.config.reeds.ClassifyConfigGroup
reVX.config.reeds.ProfilesConfigGroup
reVX.config.reeds.ReedsConfig
reVX.config.reeds.TimeslicesConfigGroup
reVX.config.rpm
reVX.config.rpm.ClusterConfigGroup
reVX.config.rpm.RPMConfig
reVX.config.rpm.RepProfilesConfigGroup
reVX.config.transmission_layer_creation
reVX.config.transmission_layer_creation.FrictionLayers
reVX.config.transmission_layer_creation.BarrierLayers
reVX.config.transmission_layer_creation.CombineCosts
reVX.config.transmission_layer_creation.DryCosts
reVX.config.transmission_layer_creation.FBLayerConfig
reVX.config.transmission_layer_creation.LayerCreationConfig
reVX.config.transmission_layer_creation.MergeFrictionBarriers
reVX.config.transmission_layer_creation.RangeConfig
reVX.config.transmission_layer_creation.Rasterize
reVX.config.transmission_layer_creation.WetCosts
reVX.config.turbine_flicker
reVX.config.turbine_flicker.TurbineFlickerConfig
reVX.config.wind_dirs
reVX.config.wind_dirs.MeanWindDirsConfig
reVX.config.wind_dirs.ProminentWindDirsConfig
reVX.handlers
reVX.handlers.database
reVX.handlers.database.Database
reVX.handlers.geopackage
reVX.handlers.geopackage.GPKGMeta
reVX.handlers.geotiff
reVX.handlers.geotiff.Geotiff
reVX.handlers.outputs
reVX.handlers.outputs.Outputs
reVX.handlers.sc_points
reVX.handlers.sc_points.Point
reVX.handlers.sc_points.SupplyCurvePoints
reVX.hybrid_stats
reVX.hybrid_stats.hybrid_stats
reVX.hybrid_stats.hybrid_stats.kendall_tau
reVX.hybrid_stats.hybrid_stats.pearson_correlation
reVX.hybrid_stats.hybrid_stats.spearman_correlation
reVX.hybrid_stats.hybrid_stats.HybridCrossCorrelation
reVX.hybrid_stats.hybrid_stats.HybridStabilityCoefficient
reVX.hybrid_stats.hybrid_stats.HybridStats
reVX.hybrid_stats.temporal_agg
reVX.hybrid_stats.temporal_agg.get_time_index
reVX.hybrid_stats.temporal_agg.DatasetAgg
reVX.hybrid_stats.temporal_agg.TemporalAgg
reVX.least_cost_xmission
reVX.least_cost_xmission.config
reVX.least_cost_xmission.config.constants
reVX.least_cost_xmission.config.xmission_config
reVX.least_cost_xmission.costs
reVX.least_cost_xmission.costs.cost_combiner
reVX.least_cost_xmission.costs.dry_cost_creator
reVX.least_cost_xmission.costs.wet_cost_creator
reVX.least_cost_xmission.dry_cost_creator_cli
reVX.least_cost_xmission.dry_cost_creator_cli.eagle
reVX.least_cost_xmission.dry_cost_creator_cli.get_node_cmd
reVX.least_cost_xmission.dry_cost_creator_cli.run_local
reVX.least_cost_xmission.layers
reVX.least_cost_xmission.layers.friction_barrier_builder
reVX.least_cost_xmission.layers.masks
reVX.least_cost_xmission.layers.transmission_layer_io_handler
reVX.least_cost_xmission.layers.utils
reVX.least_cost_xmission.least_cost_paths
reVX.least_cost_xmission.least_cost_paths.min_reinforcement_costs
reVX.least_cost_xmission.least_cost_paths.LeastCostPaths
reVX.least_cost_xmission.least_cost_paths.ReinforcementPaths
reVX.least_cost_xmission.least_cost_paths_cli
reVX.least_cost_xmission.least_cost_paths_cli.eagle
reVX.least_cost_xmission.least_cost_paths_cli.get_node_cmd
reVX.least_cost_xmission.least_cost_paths_cli.run_local
reVX.least_cost_xmission.least_cost_xmission
reVX.least_cost_xmission.least_cost_xmission.reinforcement_region_mapper
reVX.least_cost_xmission.least_cost_xmission.LeastCostXmission
reVX.least_cost_xmission.least_cost_xmission.ReinforcedXmission
reVX.least_cost_xmission.least_cost_xmission_cli
reVX.least_cost_xmission.least_cost_xmission_cli.eagle
reVX.least_cost_xmission.least_cost_xmission_cli.get_node_cmd
reVX.least_cost_xmission.least_cost_xmission_cli.run_local
reVX.least_cost_xmission.trans_cap_costs
reVX.least_cost_xmission.trans_cap_costs.ReinforcementLineCosts
reVX.least_cost_xmission.trans_cap_costs.TieLineCosts
reVX.least_cost_xmission.trans_cap_costs.TransCapCosts
reVX.least_cost_xmission.transmission_layer_creator_cli
reVX.least_cost_xmission.transmission_layer_creator_cli.FUTURE_create_h5
reVX.offshore
reVX.offshore.assembly_areas
reVX.offshore.assembly_areas.AssemblyAreas
reVX.offshore.assembly_areas_cli
reVX.offshore.assembly_areas_cli.eagle
reVX.offshore.assembly_areas_cli.get_node_cmd
reVX.offshore.assembly_areas_cli.run_local
reVX.offshore.dist_to_ports
reVX.offshore.dist_to_ports.DistanceToPorts
reVX.offshore.dist_to_ports_cli
reVX.offshore.dist_to_ports_cli.eagle
reVX.offshore.dist_to_ports_cli.get_node_cmd
reVX.offshore.dist_to_ports_cli.run_local
reVX.offshore.dist_to_ports_converter
reVX.offshore.dist_to_ports_converter.DistToPortsConverter
reVX.offshore.offshore_inputs
reVX.offshore.offshore_inputs.OffshoreInputs
reVX.offshore.offshore_inputs_cli
reVX.offshore.offshore_inputs_cli.eagle
reVX.offshore.offshore_inputs_cli.get_node_cmd
reVX.offshore.offshore_inputs_cli.run_local
reVX.plexos
reVX.plexos.base
reVX.plexos.base.BaseProfileAggregation
reVX.plexos.base.PlexosNode
reVX.plexos.dpv_plexos
reVX.plexos.dpv_plexos.DpvPlexosAggregation
reVX.plexos.dpv_plexos.DpvResource
reVX.plexos.plexos_plants
reVX.plexos.plexos_plants.PlantProfileAggregation
reVX.plexos.plexos_plants.Plants
reVX.plexos.plexos_plants.PlexosPlants
reVX.plexos.plexos_plants_cli
reVX.plexos.plexos_plants_cli.get_node_cmd
reVX.plexos.rev_reeds_plexos
reVX.plexos.rev_reeds_plexos.PlexosAggregation
reVX.plexos.rev_reeds_plexos.RevReedsPlexosManager
reVX.plexos.rev_reeds_plexos_cli
reVX.plexos.rev_reeds_plexos_cli.get_node_cmd
reVX.plexos.simple_plant_builder
reVX.plexos.simple_plant_builder.SimplePlantBuilder
reVX.plexos.simple_plant_builder_cli
reVX.plexos.utilities
reVX.plexos.utilities.get_coord_labels
reVX.plexos.utilities.parse_table_name
reVX.plexos.utilities.DataCleaner
reVX.plexos.utilities.ProjectGidHandler
reVX.pras
reVX.pras.rev_reeds_pras
reVX.pras.rev_reeds_pras.PrasAggregation
reVX.red_e
reVX.red_e.tech_potential
reVX.red_e.tech_potential.TechPotential
reVX.rpm
reVX.rpm.rpm_cli
reVX.rpm.rpm_cli.eagle
reVX.rpm.rpm_cli.get_node_cmd
reVX.rpm.rpm_cli.run_local
reVX.rpm.rpm_clusters
reVX.rpm.rpm_clusters.RPMClusters
reVX.rpm.rpm_clusters.RPMWavelets
reVX.rpm.rpm_manager
reVX.rpm.rpm_manager.RPMClusterManager
reVX.rpm.rpm_output
reVX.rpm.rpm_output.RPMOutput
reVX.rpm.rpm_output.RepresentativeProfiles
reVX.setbacks
reVX.setbacks.base
reVX.setbacks.base.BUFFERS
reVX.setbacks.base.FEATURE_FILTERS
reVX.setbacks.base.AbstractBaseSetbacks
reVX.setbacks.base.Rasterizer
reVX.setbacks.functions
reVX.setbacks.functions.features_clipped_to_county
reVX.setbacks.functions.features_with_centroid_in_county
reVX.setbacks.functions.parcel_buffer
reVX.setbacks.functions.positive_buffer
reVX.setbacks.regulations
reVX.setbacks.regulations.select_setback_regulations
reVX.setbacks.regulations.validate_setback_regulations_input
reVX.setbacks.regulations.SetbackRegulations
reVX.setbacks.regulations.WindSetbackRegulations
reVX.setbacks.setbacks
reVX.setbacks.setbacks.SETBACK_SPECS
reVX.setbacks.setbacks.setbacks_calculator
reVX.setbacks.setbacks_cli
reVX.setbacks.setbacks_cli.compute_setbacks
reVX.setbacks.setbacks_cli.merge_setbacks
reVX.setbacks.setbacks_cli.preprocess_merge_config
reVX.setbacks.setbacks_cli.preprocess_setbacks_config
reVX.setbacks.setbacks_converter
reVX.setbacks.setbacks_converter.parse_setbacks
reVX.setbacks.setbacks_converter.SetbacksConverter
reVX.turbine_flicker
reVX.turbine_flicker.regulations
reVX.turbine_flicker.regulations.FlickerRegulations
reVX.turbine_flicker.turbine_flicker
reVX.turbine_flicker.turbine_flicker.compute_flicker_exclusions
reVX.turbine_flicker.turbine_flicker.TurbineFlicker
reVX.turbine_flicker.turbine_flicker_cli
reVX.turbine_flicker.turbine_flicker_cli.eagle
reVX.turbine_flicker.turbine_flicker_cli.flicker_fn_out
reVX.turbine_flicker.turbine_flicker_cli.get_node_cmd
reVX.turbine_flicker.turbine_flicker_cli.run_local
reVX.utilities
reVX.utilities.cluster_methods
reVX.utilities.cluster_methods.ClusteringMethods
reVX.utilities.exceptions
reVX.utilities.exceptions.ExclusionsCheckError
reVX.utilities.exceptions.GeoTiffKeyError
reVX.utilities.exceptions.InvalidMCPStartValueError
reVX.utilities.exceptions.LeastCostPathNotFoundError
reVX.utilities.exceptions.RPMRuntimeError
reVX.utilities.exceptions.RPMTypeError
reVX.utilities.exceptions.RPMValueError
reVX.utilities.exceptions.ReedsKeyError
reVX.utilities.exceptions.ReedsRuntimeError
reVX.utilities.exceptions.ReedsValueError
reVX.utilities.exceptions.SupplyCurvePointCapacityError
reVX.utilities.exceptions.reVXError
reVX.utilities.exclusions
reVX.utilities.exclusions.AbstractBaseExclusionsMerger
reVX.utilities.exclusions.AbstractExclusionCalculatorInterface
reVX.utilities.exclusions.ExclusionsConverter
reVX.utilities.forecasts
reVX.utilities.forecasts.FcstUtils
reVX.utilities.output_extractor
reVX.utilities.rasterize
reVX.utilities.reeds_cols
reVX.utilities.reeds_cols.add_county_info
reVX.utilities.reeds_cols.add_extra_data
reVX.utilities.reeds_cols.add_nrel_regions
reVX.utilities.reeds_cols.add_reeds_columns
reVX.utilities.region_classifier
reVX.utilities.region_classifier.RegionClassifier
reVX.utilities.regulations
reVX.utilities.regulations.AbstractBaseRegulations
reVX.utilities.utilities
reVX.utilities.utilities.coordinate_distance
reVX.utilities.utilities.load_fips_to_state_map
reVX.utilities.utilities.log_versions
reVX.utilities.utilities.to_geo
reVX.version
reVX.wind_dirs
reVX.wind_dirs.mean_wind_dirs
reVX.wind_dirs.mean_wind_dirs.MeanWindDirections
reVX.wind_dirs.mean_wind_dirs_cli
reVX.wind_dirs.mean_wind_dirs_cli.eagle
reVX.wind_dirs.mean_wind_dirs_cli.get_node_cmd
reVX.wind_dirs.mean_wind_dirs_cli.run_local
reVX.wind_dirs.mean_wind_dirs_point
reVX.wind_dirs.mean_wind_dirs_point.MeanWindDirectionsPoint
reVX.wind_dirs.prominent_wind_dirs
reVX.wind_dirs.prominent_wind_dirs.ProminentWindDirections
reVX.wind_dirs.prominent_wind_dirs_cli
reVX.wind_dirs.prominent_wind_dirs_cli.eagle
reVX.wind_dirs.prominent_wind_dirs_cli.get_node_cmd
reVX.wind_dirs.prominent_wind_dirs_cli.run_local
CLI reference
dry-cost-creator
from-config
local
valid-config-keys
least-cost-paths
from-config
local
map-ss-to-rr
valid-config-keys
least-cost-xmission
from-config
local
merge-output
merge-reinforcement-costs
valid-config-keys
mean-wind-dirs
from-config
local
valid-config-keys
offshore-assembly-areas
from-config
local
valid-config-keys
offshore-dist-to-ports
from-config
local
valid-config-keys
offshore-inputs
from-config
local
valid-config-keys
plexos-plants
eagle
prominent-wind-dirs
from-config
local
valid-config-keys
reV-plexos
eagle
reV-rpm
from-config
local
cluster
rep-profiles
valid-config-keys
reVX
add-reeds-cols
correct-forecast
exclusions
layers-from-h5
layers-to-h5
mask
extract-output-year
region-classifier
setbacks
batch
compute
merge
pipeline
reset-status
script
status
template-configs
simple-plant-builder
transmission-layer-creator
convert-pois
create-h5
create-masks
from-config
turbine-flicker
from-config
local
valid-config-keys
reVX
reVX
reVX.cli
Edit on GitHub
reVX.cli
reVX command line interface (CLI).