Logo
  • Home page
  • Installation and Usage
    • Installation
      • Option 1: Install from PIP (recommended for analysts):
      • Option 2: Clone repo (recommended for developers)
    • reV command line tools
      • Launching a run
      • General Run times and Node configuration on Eagle
    • Recommended Citation
    • Command Line Tools
  • Examples
    • reV Project Points
      • Command Line Interface (CLI)
    • SAM Single Owner Modeling
      • Workflow Description
    • reV Marine Energy
      • Plots of the Example Marine Energy Output
    • Offshore Wind Modeling
      • reV Offshore Module Description
      • Treatment of Offshore Points in Supply Curve
      • Plots of the Example Offshore Output
    • reV Losses
      • Power Curve Losses (Wind only)
      • Power Curve Losses for a single site
      • Outage Losses (Wind and Solar)
    • Single Module Execution
    • Full Pipeline Execution
      • Pipeline Input Requirements
      • Failed Jobs
      • File Inputs
    • Batched Execution
      • Batching Config Description
      • How to Run
    • Eagle Node Requests
    • Run reV locally
      • reV Gen
        • windpower
        • pvwatts
      • Command Line Interface (CLI)
    • Running reV on an AWS Parallel Cluster
      • Setting up an AWS Parallel Cluster
      • Notes on Running reV in the AWS Parallel Cluster
      • Setting up HSDS Local Servers on your Compute Cluster
      • Setting up an HSDS Kubernetes Service
      • Setting up an HSDS Lambda Service
      • Simple H5PYD Test
      • Compute Cost Estimates
    • Running with HSDS
      • Setting up HSDS
      • Using HSDS with reV
      • reV Gen
        • windpower
        • pvwatts
      • Command Line Interface (CLI)
  • API reference
    • reV.SAM
      • reV.SAM.SAM
        • reV.SAM.SAM.RevPySam
        • reV.SAM.SAM.Sam
        • reV.SAM.SAM.SamResourceRetriever
      • reV.SAM.defaults
        • reV.SAM.defaults.AbstractDefaultFromConfigFile
        • reV.SAM.defaults.DefaultGeothermal
        • reV.SAM.defaults.DefaultLCOE
        • reV.SAM.defaults.DefaultLinearFresnelDsgIph
        • reV.SAM.defaults.DefaultMhkWave
        • reV.SAM.defaults.DefaultPvSamv1
        • reV.SAM.defaults.DefaultPvWattsv5
        • reV.SAM.defaults.DefaultPvWattsv8
        • reV.SAM.defaults.DefaultSingleOwner
        • reV.SAM.defaults.DefaultSwh
        • reV.SAM.defaults.DefaultTcsMoltenSalt
        • reV.SAM.defaults.DefaultTroughPhysicalProcessHeat
        • reV.SAM.defaults.DefaultWindPower
      • reV.SAM.econ
        • reV.SAM.econ.Economic
        • reV.SAM.econ.LCOE
        • reV.SAM.econ.SingleOwner
      • reV.SAM.generation
        • reV.SAM.generation.AbstractSamGeneration
        • reV.SAM.generation.AbstractSamGenerationFromWeatherFile
        • reV.SAM.generation.AbstractSamPv
        • reV.SAM.generation.AbstractSamSolar
        • reV.SAM.generation.AbstractSamWind
        • reV.SAM.generation.Geothermal
        • reV.SAM.generation.LinearDirectSteam
        • reV.SAM.generation.MhkWave
        • reV.SAM.generation.PvSamv1
        • reV.SAM.generation.PvWattsv5
        • reV.SAM.generation.PvWattsv7
        • reV.SAM.generation.PvWattsv8
        • reV.SAM.generation.SolarWaterHeat
        • reV.SAM.generation.TcsMoltenSalt
        • reV.SAM.generation.TroughPhysicalHeat
        • reV.SAM.generation.WindPower
        • reV.SAM.generation.WindPowerPD
      • reV.SAM.version_checker
        • reV.SAM.version_checker.PySamVersionChecker
      • reV.SAM.windbos
        • reV.SAM.windbos.WindBos
    • reV.bespoke
      • reV.bespoke.bespoke
        • reV.bespoke.bespoke.BespokeMultiPlantData
        • reV.bespoke.bespoke.BespokeSinglePlant
        • reV.bespoke.bespoke.BespokeSinglePlantData
        • reV.bespoke.bespoke.BespokeWindPlants
      • reV.bespoke.cli_bespoke
      • reV.bespoke.gradient_free
        • reV.bespoke.gradient_free.GeneticAlgorithm
      • reV.bespoke.pack_turbs
        • reV.bespoke.pack_turbs.smallest_area_with_tiebreakers
        • reV.bespoke.pack_turbs.PackTurbines
      • reV.bespoke.place_turbines
        • reV.bespoke.place_turbines.none_until_optimized
        • reV.bespoke.place_turbines.PlaceTurbines
      • reV.bespoke.plotting_functions
        • reV.bespoke.plotting_functions.get_xy
        • reV.bespoke.plotting_functions.plot_poly
        • reV.bespoke.plotting_functions.plot_turbines
        • reV.bespoke.plotting_functions.plot_windrose
    • reV.cli
    • reV.config
      • reV.config.base_analysis_config
        • reV.config.base_analysis_config.AnalysisConfig
      • reV.config.base_config
        • reV.config.base_config.BaseConfig
      • reV.config.cli_project_points
      • reV.config.curtailment
        • reV.config.curtailment.Curtailment
      • reV.config.execution
        • reV.config.execution.BaseExecutionConfig
        • reV.config.execution.HPCConfig
        • reV.config.execution.SlurmConfig
      • reV.config.output_request
        • reV.config.output_request.OutputRequest
        • reV.config.output_request.SAMOutputRequest
      • reV.config.project_points
        • reV.config.project_points.PointsControl
        • reV.config.project_points.ProjectPoints
      • reV.config.sam_config
        • reV.config.sam_config.SAMConfig
        • reV.config.sam_config.SAMInputsChecker
    • reV.econ
      • reV.econ.cli_econ
      • reV.econ.econ
        • reV.econ.econ.Econ
      • reV.econ.economies_of_scale
        • reV.econ.economies_of_scale.EconomiesOfScale
      • reV.econ.utilities
        • reV.econ.utilities.lcoe_fcr
    • reV.generation
      • reV.generation.base
        • reV.generation.base.LCOE_REQUIRED_OUTPUTS
        • reV.generation.base.BaseGen
      • reV.generation.cli_gen
      • reV.generation.generation
        • reV.generation.generation.Gen
    • reV.handlers
      • reV.handlers.cli_collect
      • reV.handlers.cli_multi_year
      • reV.handlers.exclusions
        • reV.handlers.exclusions.ExclusionLayers
      • reV.handlers.multi_year
        • reV.handlers.multi_year.my_collect_groups
        • reV.handlers.multi_year.MultiYear
        • reV.handlers.multi_year.MultiYearGroup
      • reV.handlers.outputs
        • reV.handlers.outputs.Outputs
      • reV.handlers.transmission
        • reV.handlers.transmission.TransmissionCosts
        • reV.handlers.transmission.TransmissionFeatures
    • reV.hybrids
      • reV.hybrids.cli_hybrids
      • reV.hybrids.hybrid_methods
        • reV.hybrids.hybrid_methods.aggregate_capacity
        • reV.hybrids.hybrid_methods.aggregate_capacity_factor
        • reV.hybrids.hybrid_methods.aggregate_solar_capacity
        • reV.hybrids.hybrid_methods.aggregate_wind_capacity
      • reV.hybrids.hybrids
        • reV.hybrids.hybrids.ColNameFormatter
        • reV.hybrids.hybrids.Hybridization
        • reV.hybrids.hybrids.HybridsData
        • reV.hybrids.hybrids.MetaHybridizer
        • reV.hybrids.hybrids.RatioColumns
    • reV.losses
      • reV.losses.power_curve
        • reV.losses.power_curve.TRANSFORMATIONS
        • reV.losses.power_curve.adjust_power_curve
        • reV.losses.power_curve.AbstractPowerCurveTransformation
        • reV.losses.power_curve.ExponentialStretching
        • reV.losses.power_curve.HorizontalTranslation
        • reV.losses.power_curve.LinearStretching
        • reV.losses.power_curve.PowerCurve
        • reV.losses.power_curve.PowerCurveLosses
        • reV.losses.power_curve.PowerCurveLossesInput
        • reV.losses.power_curve.PowerCurveLossesMixin
        • reV.losses.power_curve.PowerCurveWindResource
      • reV.losses.scheduled
        • reV.losses.scheduled.Outage
        • reV.losses.scheduled.OutageScheduler
        • reV.losses.scheduled.ScheduledLossesMixin
        • reV.losses.scheduled.SingleOutageScheduler
      • reV.losses.utils
        • reV.losses.utils.convert_to_full_month_names
        • reV.losses.utils.filter_unknown_month_names
        • reV.losses.utils.format_month_name
        • reV.losses.utils.full_month_name_from_abbr
        • reV.losses.utils.hourly_indices_for_months
        • reV.losses.utils.month_index
        • reV.losses.utils.month_indices
    • reV.nrwal
      • reV.nrwal.cli_nrwal
      • reV.nrwal.nrwal
        • reV.nrwal.nrwal.RevNrwal
    • reV.qa_qc
      • reV.qa_qc.cli_qa_qc
        • reV.qa_qc.cli_qa_qc.cli_qa_qc
      • reV.qa_qc.qa_qc
        • reV.qa_qc.qa_qc.QaQc
        • reV.qa_qc.qa_qc.QaQcModule
      • reV.qa_qc.summary
        • reV.qa_qc.summary.ExclusionsMask
        • reV.qa_qc.summary.PlotBase
        • reV.qa_qc.summary.SummarizeH5
        • reV.qa_qc.summary.SummarizeSupplyCurve
        • reV.qa_qc.summary.SummaryPlots
        • reV.qa_qc.summary.SupplyCurvePlot
    • reV.rep_profiles
      • reV.rep_profiles.cli_rep_profiles
      • reV.rep_profiles.rep_profiles
        • reV.rep_profiles.rep_profiles.RegionRepProfile
        • reV.rep_profiles.rep_profiles.RepProfiles
        • reV.rep_profiles.rep_profiles.RepProfilesBase
        • reV.rep_profiles.rep_profiles.RepresentativeMethods
    • reV.supply_curve
      • reV.supply_curve.aggregation
        • reV.supply_curve.aggregation.AbstractAggFileHandler
        • reV.supply_curve.aggregation.AggFileHandler
        • reV.supply_curve.aggregation.Aggregation
        • reV.supply_curve.aggregation.BaseAggregation
      • reV.supply_curve.cli_sc_aggregation
      • reV.supply_curve.cli_supply_curve
      • reV.supply_curve.competitive_wind_farms
        • reV.supply_curve.competitive_wind_farms.CompetitiveWindFarms
      • reV.supply_curve.exclusions
        • reV.supply_curve.exclusions.ExclusionMask
        • reV.supply_curve.exclusions.ExclusionMaskFromDict
        • reV.supply_curve.exclusions.FrictionMask
        • reV.supply_curve.exclusions.LayerMask
      • reV.supply_curve.extent
        • reV.supply_curve.extent.SupplyCurveExtent
      • reV.supply_curve.points
        • reV.supply_curve.points.AbstractSupplyCurvePoint
        • reV.supply_curve.points.AggregationSupplyCurvePoint
        • reV.supply_curve.points.GenerationSupplyCurvePoint
        • reV.supply_curve.points.SupplyCurvePoint
      • reV.supply_curve.sc_aggregation
        • reV.supply_curve.sc_aggregation.SupplyCurveAggFileHandler
        • reV.supply_curve.sc_aggregation.SupplyCurveAggregation
      • reV.supply_curve.supply_curve
        • reV.supply_curve.supply_curve.DEFAULT_COLUMNS
        • reV.supply_curve.supply_curve.SupplyCurve
      • reV.supply_curve.tech_mapping
        • reV.supply_curve.tech_mapping.TechMapping
    • reV.utilities
      • reV.utilities.log_versions
        • log_versions()
      • reV.utilities.FieldEnum
        • FieldEnum
      • reV.utilities.ModuleName
        • ModuleName
      • reV.utilities.ResourceMetaField
        • ResourceMetaField
      • reV.utilities.SiteDataField
        • SiteDataField
      • reV.utilities.SupplyCurveField
        • SupplyCurveField
      • reV.utilities.cli_functions
        • reV.utilities.cli_functions.format_analysis_years
        • reV.utilities.cli_functions.init_cli_logging
        • reV.utilities.cli_functions.parse_from_pipeline
      • reV.utilities.curtailment
        • reV.utilities.curtailment.curtail
      • reV.utilities.exceptions
        • reV.utilities.exceptions.CollectionRuntimeError
        • reV.utilities.exceptions.CollectionValueError
        • reV.utilities.exceptions.CollectionWarning
        • reV.utilities.exceptions.ConfigError
        • reV.utilities.exceptions.ConfigWarning
        • reV.utilities.exceptions.DataShapeError
        • reV.utilities.exceptions.EmptySupplyCurvePointError
        • reV.utilities.exceptions.ExclusionLayerError
        • reV.utilities.exceptions.ExecutionError
        • reV.utilities.exceptions.ExtrapolationWarning
        • reV.utilities.exceptions.FileInputError
        • reV.utilities.exceptions.FileInputWarning
        • reV.utilities.exceptions.HandlerKeyError
        • reV.utilities.exceptions.HandlerRuntimeError
        • reV.utilities.exceptions.HandlerValueError
        • reV.utilities.exceptions.HandlerWarning
        • reV.utilities.exceptions.InputError
        • reV.utilities.exceptions.InputWarning
        • reV.utilities.exceptions.JSONError
        • reV.utilities.exceptions.MultiFileExclusionError
        • reV.utilities.exceptions.NearestNeighborError
        • reV.utilities.exceptions.OffshoreWindInputError
        • reV.utilities.exceptions.OffshoreWindInputWarning
        • reV.utilities.exceptions.OutputWarning
        • reV.utilities.exceptions.ParallelExecutionWarning
        • reV.utilities.exceptions.PipelineError
        • reV.utilities.exceptions.ProjectPointsValueError
        • reV.utilities.exceptions.PySAMVersionError
        • reV.utilities.exceptions.PySAMVersionWarning
        • reV.utilities.exceptions.ResourceError
        • reV.utilities.exceptions.SAMExecutionError
        • reV.utilities.exceptions.SAMExecutionWarning
        • reV.utilities.exceptions.SAMInputError
        • reV.utilities.exceptions.SAMInputWarning
        • reV.utilities.exceptions.SlurmWarning
        • reV.utilities.exceptions.SupplyCurveError
        • reV.utilities.exceptions.SupplyCurveInputError
        • reV.utilities.exceptions.WhileLoopPackingError
        • reV.utilities.exceptions.reVDeprecationWarning
        • reV.utilities.exceptions.reVError
        • reV.utilities.exceptions.reVLossesValueError
        • reV.utilities.exceptions.reVLossesWarning
      • reV.utilities.pytest_utils
        • reV.utilities.pytest_utils.make_fake_h5_chunks
        • reV.utilities.pytest_utils.pd_date_range
        • reV.utilities.pytest_utils.write_chunk
      • reV.utilities.slots
        • reV.utilities.slots.SlottedDict
    • reV.version
  • CLI reference
    • reV
    • reV template-configs
    • reV batch
    • reV pipeline
    • reV project-points
      • from-lat-lons
      • from-regions
    • reV bespoke
    • reV generation
    • reV econ
    • reV collect
    • reV multi-year
    • reV supply-curve-aggregation
    • reV supply-curve
    • reV rep-profiles
    • reV hybrids
    • reV nrwal
    • reV qa-qc
    • reV script
    • reV status
    • reV reset-status
reV
  • Command Line Interfaces (CLIs)
  • Edit on GitHub

Command Line Interfaces (CLIs)

  • reV
  • reV template-configs
  • reV batch
  • reV pipeline
  • reV project-points
    • from-lat-lons
    • from-regions
  • reV bespoke
  • reV generation
  • reV econ
  • reV collect
  • reV multi-year
  • reV supply-curve-aggregation
  • reV supply-curve
  • reV rep-profiles
  • reV hybrids
  • reV nrwal
  • reV qa-qc
  • reV script
  • reV status
  • reV reset-status
Previous Next

© Copyright 2018, Alliance for Sustainable Energy, LLC.

Built with Sphinx using a theme provided by Read the Docs.