rex
  • Home page
  • Installation and Usage
    • Installation
    • Command Line Tools
  • Examples
    • NREL Renewable Energy Resource Data
      • Definitions
      • Data Format
      • Data Location - NREL Users
      • Data Location - External Users
      • Data Access Examples
        • The rex Resource Class
        • The rex Resource Extraction Class
        • Using rex with xarray
    • National Solar Radiation Database (NSRDB)
      • Description
      • NSRDB CLI
      • References
    • Wind Integration National Dataset (WIND) Toolkit
      • WIND Toolkit v1.0.0
        • WIND Toolkit References
      • 2023 National Offshore Wind data set (NOW-23)
        • NOW-23 References
      • WINDX CLI
    • High Resolution Ocean Surface Wave Hindcast (US Wave) Data
      • Description
      • Model
      • Directory structure
      • WaveX CLI
      • Direct Access via h5pyd
      • References
      • Disclaimer and Attribution
    • Highly Scalable Data Service (HSDS)
      • Extra Requirements
      • NREL Developer API
      • Setting up a Local HSDS Server
      • HSDS and rex Usage Examples
    • fsspec
      • Code Example
    • Using Xarray
      • Basic Usage
        • Opening a single file
        • Lazy Loading - rex
        • Lazy Loading - dask
        • Opening Multiple Files
      • Remote Files
        • Files on S3
        • Files on HSDS
        • Opening Multiple Remote Files
      • Parallel Computing with dask
      • Case Studies
    • Zarr
      • Extra Requirements
      • Code Example
  • API reference
    • rex.bias_correction
      • rex.bias_correction.lin_irrad
        • lin_irrad()
      • rex.bias_correction.lin_ws
        • lin_ws()
      • rex.bias_correction.qdm_irrad
        • qdm_irrad()
      • rex.bias_correction.qdm_ws
        • qdm_ws()
    • rex.external
      • rex.external.rexarray
        • rex.external.rexarray.open_mfdataset_hsds
        • rex.external.rexarray.RexArrayWrapper
        • rex.external.rexarray.RexBackendEntrypoint
        • rex.external.rexarray.RexCoordVar
        • rex.external.rexarray.RexMetaVar
        • rex.external.rexarray.RexStore
        • rex.external.rexarray.VarInfo
    • rex.joint_pd
      • rex.joint_pd.joint_pd
        • rex.joint_pd.joint_pd.JointPD
      • rex.joint_pd.wind_rose_cli
    • rex.multi_file_resource
      • rex.multi_file_resource.MultiFileNSRDB
        • MultiFileNSRDB
      • rex.multi_file_resource.MultiFileResource
        • MultiFileResource
      • rex.multi_file_resource.MultiFileWTK
        • MultiFileWTK
      • rex.multi_file_resource.MultiH5
        • MultiH5
      • rex.multi_file_resource.MultiH5Path
        • MultiH5Path
    • rex.multi_res_resource
      • rex.multi_res_resource.MultiResolutionResource
        • MultiResolutionResource
    • rex.multi_time_resource
      • rex.multi_time_resource.MultiTimeH5
        • MultiTimeH5
      • rex.multi_time_resource.MultiTimeNSRDB
        • MultiTimeNSRDB
      • rex.multi_time_resource.MultiTimeResource
        • MultiTimeResource
      • rex.multi_time_resource.MultiTimeSolarResource
        • MultiTimeSolarResource
      • rex.multi_time_resource.MultiTimeWaveResource
        • MultiTimeWaveResource
      • rex.multi_time_resource.MultiTimeWindResource
        • MultiTimeWindResource
    • rex.multi_year_resource
      • rex.multi_year_resource.MultiYearH5
        • MultiYearH5
      • rex.multi_year_resource.MultiYearNSRDB
        • MultiYearNSRDB
      • rex.multi_year_resource.MultiYearResource
        • MultiYearResource
      • rex.multi_year_resource.MultiYearSolarResource
        • MultiYearSolarResource
      • rex.multi_year_resource.MultiYearWaveResource
        • MultiYearWaveResource
      • rex.multi_year_resource.MultiYearWindResource
        • MultiYearWindResource
    • rex.outputs
      • rex.outputs.Outputs
        • Outputs
    • rex.rechunk_h5
      • rex.rechunk_h5.chunk_size
        • rex.rechunk_h5.chunk_size.ArrayChunkSize
        • rex.rechunk_h5.chunk_size.BaseChunkSize
        • rex.rechunk_h5.chunk_size.TimeseriesChunkSize
      • rex.rechunk_h5.combine_h5
        • rex.rechunk_h5.combine_h5.CombineH5
      • rex.rechunk_h5.combine_h5_cli
      • rex.rechunk_h5.rechunk_cli
      • rex.rechunk_h5.rechunk_h5
        • rex.rechunk_h5.rechunk_h5.get_dataset_attributes
        • rex.rechunk_h5.rechunk_h5.RechunkH5
    • rex.renewable_resource
      • rex.renewable_resource.linear_interp
        • linear_interp()
      • rex.renewable_resource.AbstractInterpolatedResource
        • AbstractInterpolatedResource
      • rex.renewable_resource.GeothermalResource
        • GeothermalResource
      • rex.renewable_resource.NSRDB
        • NSRDB
      • rex.renewable_resource.SolarResource
        • SolarResource
      • rex.renewable_resource.WaveResource
        • WaveResource
      • rex.renewable_resource.WindResource
        • WindResource
    • rex.resource
      • rex.resource.BaseDatasetIterable
        • BaseDatasetIterable
      • rex.resource.BaseResource
        • BaseResource
      • rex.resource.Resource
        • Resource
      • rex.resource.ResourceDataset
        • ResourceDataset
    • rex.resource_extraction
      • rex.resource_extraction.US_wave_cli
      • rex.resource_extraction.multi_year_resource_cli
      • rex.resource_extraction.nsrdb_cli
      • rex.resource_extraction.resource_cli
      • rex.resource_extraction.resource_extraction
        • rex.resource_extraction.resource_extraction.MultiFileNSRDBX
        • rex.resource_extraction.resource_extraction.MultiFileResourceX
        • rex.resource_extraction.resource_extraction.MultiFileWindX
        • rex.resource_extraction.resource_extraction.MultiTimeNSRDBX
        • rex.resource_extraction.resource_extraction.MultiTimeResourceX
        • rex.resource_extraction.resource_extraction.MultiTimeWaveX
        • rex.resource_extraction.resource_extraction.MultiTimeWindX
        • rex.resource_extraction.resource_extraction.MultiYearNSRDBX
        • rex.resource_extraction.resource_extraction.MultiYearResourceX
        • rex.resource_extraction.resource_extraction.MultiYearWaveX
        • rex.resource_extraction.resource_extraction.MultiYearWindX
        • rex.resource_extraction.resource_extraction.NSRDBX
        • rex.resource_extraction.resource_extraction.ResourceX
        • rex.resource_extraction.resource_extraction.SolarX
        • rex.resource_extraction.resource_extraction.WaveX
        • rex.resource_extraction.resource_extraction.WindX
      • rex.resource_extraction.wave_cli
      • rex.resource_extraction.wind_cli
    • rex.sam_resource
      • rex.sam_resource.SAMResource
        • SAMResource
    • rex.temporal_stats
      • rex.temporal_stats.temporal_stats
        • rex.temporal_stats.temporal_stats.cdf
        • rex.temporal_stats.temporal_stats.circular_mean
        • rex.temporal_stats.temporal_stats.TemporalStats
      • rex.temporal_stats.temporal_stats_cli
    • rex.utilities
      • rex.utilities.bc_parse_table
        • rex.utilities.bc_parse_table.parse_bc_table
      • rex.utilities.bc_utils
        • rex.utilities.bc_utils.sample_cdf
        • rex.utilities.bc_utils.sample_q_invlog
        • rex.utilities.bc_utils.sample_q_linear
        • rex.utilities.bc_utils.sample_q_log
        • rex.utilities.bc_utils.QuantileDeltaMapping
      • rex.utilities.cli_dtypes
        • rex.utilities.cli_dtypes.sanitize_str
        • rex.utilities.cli_dtypes.FloatListType
        • rex.utilities.cli_dtypes.FloatType
        • rex.utilities.cli_dtypes.IntListType
        • rex.utilities.cli_dtypes.IntType
        • rex.utilities.cli_dtypes.ListType
        • rex.utilities.cli_dtypes.PathListType
        • rex.utilities.cli_dtypes.StrFloatType
        • rex.utilities.cli_dtypes.StrListType
        • rex.utilities.cli_dtypes.StrOrListType
        • rex.utilities.cli_dtypes.StrType
      • rex.utilities.exceptions
        • rex.utilities.exceptions.ExecutionError
        • rex.utilities.exceptions.ExtrapolationWarning
        • rex.utilities.exceptions.FileInputError
        • rex.utilities.exceptions.HandlerRuntimeError
        • rex.utilities.exceptions.HandlerValueError
        • rex.utilities.exceptions.HpcError
        • rex.utilities.exceptions.JSONError
        • rex.utilities.exceptions.LoggerWarning
        • rex.utilities.exceptions.MoninObukhovExtrapolationError
        • rex.utilities.exceptions.ParallelExecutionWarning
        • rex.utilities.exceptions.PbsWarning
        • rex.utilities.exceptions.ResourceError
        • rex.utilities.exceptions.ResourceKeyError
        • rex.utilities.exceptions.ResourceRuntimeError
        • rex.utilities.exceptions.ResourceValueError
        • rex.utilities.exceptions.ResourceWarning
        • rex.utilities.exceptions.RetryError
        • rex.utilities.exceptions.RetryWarning
        • rex.utilities.exceptions.SAMInputWarning
        • rex.utilities.exceptions.SlurmError
        • rex.utilities.exceptions.SlurmWarning
      • rex.utilities.execution
        • rex.utilities.execution.execute_parallel
        • rex.utilities.execution.execute_single
        • rex.utilities.execution.SmartParallelJob
        • rex.utilities.execution.SpawnProcessPool
        • rex.utilities.execution.SubprocessManager
      • rex.utilities.fun_utils
        • rex.utilities.fun_utils.arg_to_str
        • rex.utilities.fun_utils.get_arg_str
        • rex.utilities.fun_utils.get_class
        • rex.utilities.fun_utils.get_fun_call_str
        • rex.utilities.fun_utils.get_fun_str
        • rex.utilities.fun_utils.has_class
        • rex.utilities.fun_utils.is_standalone_fun
      • rex.utilities.hpc
        • rex.utilities.hpc.HpcJobManager
        • rex.utilities.hpc.PBS
        • rex.utilities.hpc.SLURM
      • rex.utilities.loggers
        • rex.utilities.loggers.add_handlers
        • rex.utilities.loggers.clear_handlers
        • rex.utilities.loggers.create_dirs
        • rex.utilities.loggers.get_handler
        • rex.utilities.loggers.init_logger
        • rex.utilities.loggers.init_mult
        • rex.utilities.loggers.log_mem
        • rex.utilities.loggers.log_versions
        • rex.utilities.loggers.setup_logger
        • rex.utilities.loggers.LoggingAttributes
      • rex.utilities.parse_keys
        • rex.utilities.parse_keys.parse_keys
        • rex.utilities.parse_keys.parse_slice
      • rex.utilities.regridder
        • rex.utilities.regridder.CachedRegridder
        • rex.utilities.regridder.Regridder
      • rex.utilities.solar_position
        • rex.utilities.solar_position.SolarPosition
      • rex.utilities.toml_parser
        • rex.utilities.toml_parser.flatten_dict
        • rex.utilities.toml_parser.TOMLParser
      • rex.utilities.utilities
        • rex.utilities.utilities.assert_read_only_mode
        • rex.utilities.utilities.check_eval_str
        • rex.utilities.utilities.check_hsds_file
        • rex.utilities.utilities.check_res_file
        • rex.utilities.utilities.check_tz
        • rex.utilities.utilities.dict_str_load
        • rex.utilities.utilities.filename_from_h5pyd
        • rex.utilities.utilities.filename_timestamp
        • rex.utilities.utilities.get_chunk_ranges
        • rex.utilities.utilities.get_class_properties
        • rex.utilities.utilities.get_dtype
        • rex.utilities.utilities.get_lat_lon_cols
        • rex.utilities.utilities.import_io_module_or_fail
        • rex.utilities.utilities.is_hsds_file
        • rex.utilities.utilities.is_s3_file
        • rex.utilities.utilities.jsonify_dict
        • rex.utilities.utilities.mean_irrad
        • rex.utilities.utilities.parse_date_int
        • rex.utilities.utilities.parse_table
        • rex.utilities.utilities.parse_timestamp
        • rex.utilities.utilities.parse_year
        • rex.utilities.utilities.pd_date_range
        • rex.utilities.utilities.res_dist_threshold
        • rex.utilities.utilities.rex_unscale
        • rex.utilities.utilities.roll_timeseries
        • rex.utilities.utilities.row_col_indices
        • rex.utilities.utilities.safe_json_load
        • rex.utilities.utilities.safe_yaml_load
        • rex.utilities.utilities.slice_sites
        • rex.utilities.utilities.split_sites_list
        • rex.utilities.utilities.split_sites_slice
        • rex.utilities.utilities.str_to_date
        • rex.utilities.utilities.str_to_datetime
        • rex.utilities.utilities.timestamp_format_to_redex
        • rex.utilities.utilities.to_records_array
        • rex.utilities.utilities.unstupify_path
        • rex.utilities.utilities.validate_filepath
        • rex.utilities.utilities.write_json
        • rex.utilities.utilities.Retry
    • rex.version
  • CLI reference
    • combine-h5
    • MultiYearX
      • dataset
        • box
        • map-means
        • multi-site
        • region
        • site
    • NSRDBX
      • dataset
        • box
        • multi-site
        • region
        • site
      • sam-datasets
    • rechunk
    • rex
      • dataset
        • box
        • multi-site
        • region
        • site
      • sam-datasets
    • temporal-stats
      • diurnal
      • full
      • monthly
      • monthly-diurnal
    • US-wave
      • dataset
        • box
        • map-means
        • multi-site
        • region
        • site
    • WaveX
      • dataset
        • box
        • multi-site
        • region
        • site
      • sam-datasets
    • wind-rose
    • WINDX
      • dataset
        • box
        • multi-site
        • region
        • site
      • sam-datasets
rex
  • Examples
  • Edit on GitHub

Examples

  • NREL Renewable Energy Resource Data
    • Definitions
    • Data Format
    • Data Location - NREL Users
    • Data Location - External Users
    • Data Access Examples
      • The rex Resource Class
      • The rex Resource Extraction Class
      • Using rex with xarray
  • National Solar Radiation Database (NSRDB)
    • Description
    • NSRDB CLI
    • References
  • Wind Integration National Dataset (WIND) Toolkit
    • WIND Toolkit v1.0.0
      • WIND Toolkit References
    • 2023 National Offshore Wind data set (NOW-23)
      • NOW-23 References
    • WINDX CLI
  • High Resolution Ocean Surface Wave Hindcast (US Wave) Data
    • Description
    • Model
    • Directory structure
    • WaveX CLI
    • Direct Access via h5pyd
    • References
    • Disclaimer and Attribution
  • Highly Scalable Data Service (HSDS)
    • Extra Requirements
    • NREL Developer API
    • Setting up a Local HSDS Server
    • HSDS and rex Usage Examples
  • fsspec
    • Code Example
  • Using Xarray
    • Basic Usage
      • Opening a single file
      • Lazy Loading - rex
      • Lazy Loading - dask
      • Opening Multiple Files
    • Remote Files
      • Files on S3
      • Files on HSDS
      • Opening Multiple Remote Files
    • Parallel Computing with dask
    • Case Studies
  • Zarr
    • Extra Requirements
    • Code Example
Previous Next

© Copyright 2020, Alliance for Sustainable Energy, LLC.

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