Skip to main content
Ctrl+K
ScopeSim - Home ScopeSim - Home
Ctrl+K
  • The ScopeSim python ecosystem

Contents:

  • Getting started
  • Examples
    • 1: A quick use case for MICADO at the ELT
    • 2: Observing the same object with multiple telescopes
    • 3: Writing and including custom Effects
  • Hints and Tricks
    • Using !-string and #-string commands
    • Turning Effect objects on or off
    • Downloading packages
    • Science target templates
    • Global rc simulation parameters
    • Source : from FITS images
    • Source : Point sources from arrays
  • FAQs
    • Binding ScopeSim to a local copy of the IRDB
    • Approximate sketch of “units flow” in ScopeSim

Package Contents

  • scopesim.commands
    • scopesim.commands.scopesimple
      • scopesim.commands.scopesimple.Simulation
    • scopesim.commands.user_commands
      • scopesim.commands.user_commands.add_packages_to_rc_search
      • scopesim.commands.user_commands.check_for_updates
      • scopesim.commands.user_commands.check_version
      • scopesim.commands.user_commands.list_local_packages
      • scopesim.commands.user_commands.load_yaml_dicts
      • scopesim.commands.user_commands.patch_fake_symlinks
      • scopesim.commands.user_commands.UserCommands
  • scopesim.detector
    • scopesim.detector.detector
      • scopesim.detector.detector.Detector
    • scopesim.detector.detector_manager
      • scopesim.detector.detector_manager.DetectorManager
    • scopesim.detector.nghxrg
      • scopesim.detector.nghxrg.HXRGNoise
  • scopesim.effects
    • scopesim.effects.apertures
      • scopesim.effects.apertures.make_aperture_polygon
      • scopesim.effects.apertures.mask_from_coords
      • scopesim.effects.apertures.points_on_a_circle
      • scopesim.effects.apertures.rotate
      • scopesim.effects.apertures.ApertureList
      • scopesim.effects.apertures.ApertureMask
      • scopesim.effects.apertures.RectangularApertureMask
      • scopesim.effects.apertures.SlitWheel
    • scopesim.effects.binning_3d
      • scopesim.effects.binning_3d.FluxBinning3D
    • scopesim.effects.data_container
      • scopesim.effects.data_container.DataContainer
    • scopesim.effects.detector_list
      • scopesim.effects.detector_list.DetectorList
      • scopesim.effects.detector_list.DetectorList3D
      • scopesim.effects.detector_list.DetectorWindow
    • scopesim.effects.effects
      • scopesim.effects.effects.Effect
    • scopesim.effects.effects_utils
      • scopesim.effects.effects_utils.get_all_effects
      • scopesim.effects.effects_utils.is_spectroscope
      • scopesim.effects.effects_utils.make_effect
      • scopesim.effects.effects_utils.scopesim_effect_classes
      • scopesim.effects.effects_utils.z_order_in_range
    • scopesim.effects.electronic
      • scopesim.effects.electronic.Quantization
      • scopesim.effects.electronic.SummedExposure
      • scopesim.effects.electronic.ElectronicEffect
      • scopesim.effects.electronic.dmps
        • scopesim.effects.electronic.dmps.DetectorModePropertiesSetter
      • scopesim.effects.electronic.electrons
        • scopesim.effects.electronic.electrons.ADConversion
        • scopesim.effects.electronic.electrons.InterPixelCapacitance
        • scopesim.effects.electronic.electrons.LinearityCurve
      • scopesim.effects.electronic.exposure
        • scopesim.effects.electronic.exposure.AutoExposure
        • scopesim.effects.electronic.exposure.ExposureIntegration
        • scopesim.effects.electronic.exposure.ExposureOutput
      • scopesim.effects.electronic.noise
        • scopesim.effects.electronic.noise.BasicReadoutNoise
        • scopesim.effects.electronic.noise.Bias
        • scopesim.effects.electronic.noise.DarkCurrent
        • scopesim.effects.electronic.noise.PixelResponseNonUniformity
        • scopesim.effects.electronic.noise.PoorMansHxRGReadoutNoise
        • scopesim.effects.electronic.noise.RandomEffect
        • scopesim.effects.electronic.noise.ShotNoise
      • scopesim.effects.electronic.pixels
        • scopesim.effects.electronic.pixels.BinnedImage
        • scopesim.effects.electronic.pixels.BinnedImageBase
        • scopesim.effects.electronic.pixels.ReferencePixelBorder
        • scopesim.effects.electronic.pixels.UnequalBinnedImage
    • scopesim.effects.fits_headers
      • scopesim.effects.fits_headers.flatten_dict
      • scopesim.effects.fits_headers.EffectsMetaKeywords
      • scopesim.effects.fits_headers.ExtraFitsKeywords
      • scopesim.effects.fits_headers.SimulationConfigFitsKeywords
      • scopesim.effects.fits_headers.SourceDescriptionFitsKeywords
    • scopesim.effects.illumination
      • scopesim.effects.illumination.gaussian2d
      • scopesim.effects.illumination.quadratic_vignetting
      • scopesim.effects.illumination.Illumination
    • scopesim.effects.metis_ifu_simple
      • scopesim.effects.metis_ifu_simple.ifu_simple
        • scopesim.effects.metis_ifu_simple.ifu_simple.LineSpreadFunction
    • scopesim.effects.metis_lms_trace_list
      • scopesim.effects.metis_lms_trace_list.echelle_setting
      • scopesim.effects.metis_lms_trace_list.predisperser_angle
      • scopesim.effects.metis_lms_trace_list.MetisLMSEfficiency
      • scopesim.effects.metis_lms_trace_list.MetisLMSImageSlicer
      • scopesim.effects.metis_lms_trace_list.MetisLMSSpectralTrace
      • scopesim.effects.metis_lms_trace_list.MetisLMSSpectralTraceList
    • scopesim.effects.metis_wcu
      • scopesim.effects.metis_wcu.fpmask
        • scopesim.effects.metis_wcu.fpmask.FPMask
      • scopesim.effects.metis_wcu.metis_wcu
        • scopesim.effects.metis_wcu.metis_wcu.get_reflectivity
        • scopesim.effects.metis_wcu.metis_wcu.WCUSource
    • scopesim.effects.micado_ifu_trace_list
      • scopesim.effects.micado_ifu_trace_list.MicadoIFUSpectralTrace
      • scopesim.effects.micado_ifu_trace_list.MicadoIFUSpectralTraceList
    • scopesim.effects.mosaic_trace_list
      • scopesim.effects.mosaic_trace_list.MosaicOutputFormat
      • scopesim.effects.mosaic_trace_list.MosaicSpectralTrace
      • scopesim.effects.mosaic_trace_list.MosaicSpectralTraceList
      • scopesim.effects.mosaic_trace_list.Transform1D
    • scopesim.effects.obs_strategies
      • scopesim.effects.obs_strategies.chop_nod_image
      • scopesim.effects.obs_strategies.ChopNodCombiner
    • scopesim.effects.psfs
      • scopesim.effects.psfs.analytical
        • scopesim.effects.psfs.analytical.wfe2gauss
        • scopesim.effects.psfs.analytical.wfe2strehl
        • scopesim.effects.psfs.analytical.AnalyticalPSF
        • scopesim.effects.psfs.analytical.GaussianDiffractionPSF
        • scopesim.effects.psfs.analytical.NonCommonPathAberration
        • scopesim.effects.psfs.analytical.SeeingPSF
        • scopesim.effects.psfs.analytical.Vibration
      • scopesim.effects.psfs.discrete
        • scopesim.effects.psfs.discrete.get_strehl_cutout
        • scopesim.effects.psfs.discrete.DiscretePSF
        • scopesim.effects.psfs.discrete.FieldConstantPSF
        • scopesim.effects.psfs.discrete.FieldVaryingPSF
      • scopesim.effects.psfs.psf_base
        • scopesim.effects.psfs.psf_base.get_bkg_level
        • scopesim.effects.psfs.psf_base.rotational_blur
        • scopesim.effects.psfs.psf_base.PSF
        • scopesim.effects.psfs.psf_base.PoorMansFOV
      • scopesim.effects.psfs.semianalytical
        • scopesim.effects.psfs.semianalytical.nmrms_from_strehl_and_wavelength
        • scopesim.effects.psfs.semianalytical.AnisocadoConstPSF
        • scopesim.effects.psfs.semianalytical.SemiAnalyticalPSF
    • scopesim.effects.rotation
      • scopesim.effects.rotation.Rotate90CCD
    • scopesim.effects.shifts
      • scopesim.effects.shifts.atmospheric_refraction
      • scopesim.effects.shifts.get_pixel_border_waves_from_atmo_disp
      • scopesim.effects.shifts.AtmosphericDispersion
      • scopesim.effects.shifts.AtmosphericDispersionCorrection
      • scopesim.effects.shifts.Shift3D
    • scopesim.effects.shutter
      • scopesim.effects.shutter.Shutter
    • scopesim.effects.spectral_efficiency
      • scopesim.effects.spectral_efficiency.SpectralEfficiency
    • scopesim.effects.spectral_trace_list
      • scopesim.effects.spectral_trace_list.SpectralTraceList
      • scopesim.effects.spectral_trace_list.SpectralTraceListWheel
    • scopesim.effects.spectral_trace_list_utils
      • scopesim.effects.spectral_trace_list_utils.det_offset
      • scopesim.effects.spectral_trace_list_utils.fill_zeros
      • scopesim.effects.spectral_trace_list_utils.fit2matrix
      • scopesim.effects.spectral_trace_list_utils.get_affine_parameters
      • scopesim.effects.spectral_trace_list_utils.make_image_interpolations
      • scopesim.effects.spectral_trace_list_utils.rolling_median
      • scopesim.effects.spectral_trace_list_utils.xilam2xy_fit
      • scopesim.effects.spectral_trace_list_utils.xy2xilam_fit
      • scopesim.effects.spectral_trace_list_utils.SpectralTrace
      • scopesim.effects.spectral_trace_list_utils.Transform2D
      • scopesim.effects.spectral_trace_list_utils.XiLamImage
    • scopesim.effects.surface_list
      • scopesim.effects.surface_list.SurfaceList
    • scopesim.effects.ter_curves
      • scopesim.effects.ter_curves.ADCWheel
      • scopesim.effects.ter_curves.AtmoLibraryTERCurve
      • scopesim.effects.ter_curves.AtmosphericTERCurve
      • scopesim.effects.ter_curves.DownloadableFilterCurve
      • scopesim.effects.ter_curves.FilterCurve
      • scopesim.effects.ter_curves.FilterWheel
      • scopesim.effects.ter_curves.FilterWheelBase
      • scopesim.effects.ter_curves.PupilMaskWheel
      • scopesim.effects.ter_curves.PupilTransmission
      • scopesim.effects.ter_curves.QuantumEfficiencyCurve
      • scopesim.effects.ter_curves.SkycalcTERCurve
      • scopesim.effects.ter_curves.SpanishVOFilterCurve
      • scopesim.effects.ter_curves.SpanishVOFilterWheel
      • scopesim.effects.ter_curves.TERCurve
      • scopesim.effects.ter_curves.TopHatFilterCurve
      • scopesim.effects.ter_curves.TopHatFilterWheel
    • scopesim.effects.ter_curves_utils
      • scopesim.effects.ter_curves_utils.add_edge_zeros
      • scopesim.effects.ter_curves_utils.download_svo_filter
      • scopesim.effects.ter_curves_utils.download_svo_filter_list
      • scopesim.effects.ter_curves_utils.get_filter
      • scopesim.effects.ter_curves_utils.get_filter_effective_wavelength
  • scopesim.optics
    • scopesim.optics.fov
      • scopesim.optics.fov.extract_range_from_spectrum
      • scopesim.optics.fov.replace_nans
      • scopesim.optics.fov.FieldOfView
      • scopesim.optics.fov.FieldOfView1D
      • scopesim.optics.fov.FieldOfView2D
      • scopesim.optics.fov.FieldOfView3D
    • scopesim.optics.fov_manager
      • scopesim.optics.fov_manager.chunk_edges
      • scopesim.optics.fov_manager.FOVManager
    • scopesim.optics.fov_volume_list
      • scopesim.optics.fov_volume_list.FovVolumeList
    • scopesim.optics.image_plane
      • scopesim.optics.image_plane.ImagePlane
    • scopesim.optics.image_plane_utils
      • scopesim.optics.image_plane_utils.add_imagehdu_to_imagehdu
      • scopesim.optics.image_plane_utils.affine_map
      • scopesim.optics.image_plane_utils.calc_footprint
      • scopesim.optics.image_plane_utils.create_wcs_from_points
      • scopesim.optics.image_plane_utils.det_wcs_from_sky_wcs
      • scopesim.optics.image_plane_utils.header_from_list_of_xy
      • scopesim.optics.image_plane_utils.overlay_image
      • scopesim.optics.image_plane_utils.pix2val
      • scopesim.optics.image_plane_utils.reorient_imagehdu
      • scopesim.optics.image_plane_utils.rescale_imagehdu
      • scopesim.optics.image_plane_utils.sky_wcs_from_det_wcs
      • scopesim.optics.image_plane_utils.sub_pixel_fractions
      • scopesim.optics.image_plane_utils.val2pix
    • scopesim.optics.optical_element
      • scopesim.optics.optical_element.OpticalElement
    • scopesim.optics.optical_train
      • scopesim.optics.optical_train.apply_fov_effects
      • scopesim.optics.optical_train.extract_source
      • scopesim.optics.optical_train.view_fov
      • scopesim.optics.optical_train.OpticalTrain
    • scopesim.optics.optics_manager
      • scopesim.optics.optics_manager.OpticsManager
    • scopesim.optics.surface
      • scopesim.optics.surface.scale_spectrum
      • scopesim.optics.surface.PoorMansSurface
      • scopesim.optics.surface.SpectralSurface
    • scopesim.optics.surface_utils
      • scopesim.optics.surface_utils.extract_base_from_unit
      • scopesim.optics.surface_utils.extract_type_from_unit
      • scopesim.optics.surface_utils.make_emission_from_array
      • scopesim.optics.surface_utils.make_emission_from_emissivity
      • scopesim.optics.surface_utils.normalise_flux_if_binned
  • scopesim.server
    • scopesim.server.database
      • scopesim.server.database.check_packages
      • scopesim.server.database.crawl_server_dirs
      • scopesim.server.database.download_missing_pkgs
      • scopesim.server.database.download_packages
      • scopesim.server.database.get_all_latest
      • scopesim.server.database.get_all_package_versions
      • scopesim.server.database.get_all_packages_on_server
      • scopesim.server.database.get_all_stable
      • scopesim.server.database.get_latest
      • scopesim.server.database.get_package_folders
      • scopesim.server.database.get_server_folder_package_names
      • scopesim.server.database.get_stable
      • scopesim.server.database.group_package_versions
      • scopesim.server.database.list_packages
      • scopesim.server.database.PkgNotFoundError
    • scopesim.server.download_utils
      • scopesim.server.download_utils.create_client
      • scopesim.server.download_utils.create_retriever
      • scopesim.server.download_utils.get_base_url
      • scopesim.server.download_utils.get_local_packages_path
      • scopesim.server.download_utils.get_server_folder_contents
      • scopesim.server.download_utils.handle_download
      • scopesim.server.download_utils.handle_unzipping
      • scopesim.server.download_utils.send_get
      • scopesim.server.download_utils.ServerError
    • scopesim.server.example_data_utils
      • scopesim.server.example_data_utils.download_example_data
      • scopesim.server.example_data_utils.list_example_data
  • scopesim.source
    • scopesim.source.source
      • scopesim.source.source.Source
    • scopesim.source.source_fields
      • scopesim.source.source_fields.BackgroundSourceField
      • scopesim.source.source_fields.CubeSourceField
      • scopesim.source.source_fields.HDUSourceField
      • scopesim.source.source_fields.ImageSourceField
      • scopesim.source.source_fields.SourceField
      • scopesim.source.source_fields.SpectrumSourceField
      • scopesim.source.source_fields.TableSourceField
    • scopesim.source.source_templates
      • scopesim.source.source_templates.ab_spectrum
      • scopesim.source.source_templates.empty_sky
      • scopesim.source.source_templates.st_spectrum
      • scopesim.source.source_templates.star
      • scopesim.source.source_templates.star_field
      • scopesim.source.source_templates.uniform_illumination
      • scopesim.source.source_templates.uniform_source
      • scopesim.source.source_templates.vega_spectrum
    • scopesim.source.source_utils
      • scopesim.source.source_utils.convert_to_list_of_spectra
      • scopesim.source.source_utils.make_img_wcs_header
      • scopesim.source.source_utils.parse_sed_table
      • scopesim.source.source_utils.validate_source_input
  • scopesim.utils
    • scopesim.utils.airmass2zendist
    • scopesim.utils.airmass_to_zenith_dist
    • scopesim.utils.array_minmax
    • scopesim.utils.bug_report
    • scopesim.utils.bug_report_to_file
    • scopesim.utils.change_table_entry
    • scopesim.utils.check_keys
    • scopesim.utils.close_loop
    • scopesim.utils.convert_table_comments_to_dict
    • scopesim.utils.cube_plotter
    • scopesim.utils.deriv_polynomial2d
    • scopesim.utils.figure_factory
    • scopesim.utils.figure_grid_factory
    • scopesim.utils.find_file
    • scopesim.utils.from_currsys
    • scopesim.utils.from_rc_config
    • scopesim.utils.get_fits_type
    • scopesim.utils.get_meta_quantity
    • scopesim.utils.has_needed_keywords
    • scopesim.utils.image_plotter
    • scopesim.utils.is_fits
    • scopesim.utils.link_irdb
    • scopesim.utils.log_bug_report
    • scopesim.utils.log_to_file
    • scopesim.utils.nearest
    • scopesim.utils.parallactic_angle
    • scopesim.utils.pixel_area
    • scopesim.utils.power_vector
    • scopesim.utils.pretty_print_dict
    • scopesim.utils.quantify
    • scopesim.utils.quantity_from_table
    • scopesim.utils.real_colname
    • scopesim.utils.seq
    • scopesim.utils.set_console_log_level
    • scopesim.utils.set_inst_pkgs_path
    • scopesim.utils.stringify_dict
    • scopesim.utils.top_level_catch
    • scopesim.utils.unit_from_table
    • scopesim.utils.unit_includes_per_physical_type
    • scopesim.utils.update_logging
    • scopesim.utils.write_report
    • scopesim.utils.zendist2airmass
    • scopesim.utils.zenith_dist_to_airmass
    • scopesim.utils.zeros_from_header
    • scopesim.utils.ScopesimPendingDeprecationWarning
  • .rst

Examples

Examples#

Contents:

  • 1: A quick use case for MICADO at the ELT
    • A brief introduction into using ScopeSim to observe a cluster in the LMC
  • 2: Observing the same object with multiple telescopes
    • Create a star cluster Source object
    • Observe the source
    • Plot up the results
  • 3: Writing and including custom Effects
    • Create and optical model for MICADO and the ELT
    • Writing a custom Effect object
    • Including a custom Effect

previous

Getting started

next

1: A quick use case for MICADO at the ELT

By Kieran Leschinski, Oliver Czoske, Fabian Haberhauer

© Copyright 2024, A*Vienna.