Welcome to SCIFYsim’s documentation!

Quick start

After you have installed SCIFYsim, you can get taste of SCIFYsim by running the notebook SCIFYsim/scifysim/quick_start.ipynb. This will get you through the initialization of a simulator object and make your first exposures.

What you need to know

SCIFYsim does not have a GUI. You will have to interface with it through the API. You our recommendation is to use jupyter(lab) to create semi-interactive scripts to run the simulations and plot the data. You can also use scripts for a more rigid usage.

It uses:

• Possibly extended stars and sources of interest using blackbody spectrum or provided spectra.

• The projection of the observing array of pupils

• Absorption and thermal emission of the train of optics and atmosphere

• Random optical path aberrations from fringe tracking error power spectra

• Random injection aberrations based on partially AO-corrected wavefront

• Atmospheric dispersion effects and their correction devices (Work in progress)

• Beam combination in an interchangeable combiner matrix (including chromatic aberrations)

• Spectrograph and detector integration

It produces:

• Direct and differential (kernel) maps of the transmission in the field of view

• Temporal series of simulated observations

• Characterization of noises from

  • Thermal background

  • Photon noise

  • Instrumental aberrations

• Computation of detection sensitivity based on advanced hypothesis testing techniques [1] combining the evolution of the baselines and all the spectral channels.

More information here.

Table of Contents

• Installing SCIFYsim
  • Prerequisites
  • Quick install
  • Kernuller
  • XAOSIM
  • Installing SCIFYsim
  • Setting up a workspace
• What you need to know
  • Philosophy
  • Simulator
  • Simulating an exposure
  • Useful tools
• Documentation recipe
• scifysim
  • scifysim package
• scifysim.analysis module
  • BasicETC
  • F2mag()
  • contrib2variance()
  • correlation_map()
  • get_Tnp_threshold()
  • get_Tnp_threshold_map()
  • get_planet_residual()
  • get_sensitivity_Te()
  • get_sensitivity_Te_old()
  • get_sensitivity_Tnp()
  • get_sensitivity_Tnp_old()
  • mag2F()
  • make_source()
  • make_th_exps()
  • noiseprofile
  • pdet_e()
  • residual_pdet_Te()
  • residual_pdet_Tnp()
  • simplified_context
  • spectral_context
• scifysim.combiner module
  • combiner
  • test_angel_woolf()
  • test_combiner()
• scifysim.combiners module
  • ABCD()
  • GLINT()
  • GRAVITY()
  • VIKiNG()
  • angel_woolf_ph()
  • angel_woolf_ph_chromatic()
  • bracewell_ph()
  • four2six()
  • four_photometric()
  • geom_ph_shifter()
  • kernel_nuller_3T()
  • kernel_nuller_4T()
  • kernel_nuller_5T()
  • kernel_nuller_6T()
  • ph_shifter()
  • piston2phase()
  • sp_clip_rows()
  • test_combiners()
• scifysim.confconverter module
  • convert_config_file()
  • set_logging_level()
• scifysim.correctors module
  • bs2bcs()
  • corrector
  • extract_corrector_params()
  • generic_vacuum()
  • get_Is()
  • get_contrast_res()
  • get_depth()
  • get_es()
  • get_max_differential()
  • get_shape_res()
  • material_sellmeier
  • no_material()
  • offband_ft
• scifysim.director module
  • simulator
  • test_director()
• scifysim.injection module
  • Hn()
  • J0
  • J1
  • K0
  • atmo
  • atmo_screen()
  • fiber_head
  • focuser
  • fringe_tracker
  • gaussian_fiber_head
  • injection_cloud
  • injection_vigneting
  • injector
  • optimize_a()
  • seeing_to_r0()
  • tel_pupil()
  • test_fiber()
  • test_injection()
  • test_injection_fromfile()
  • test_injection_function()
• scifysim.map_manager module
  • map_meta
• scifysim.mol_dens module
  • mol_dens()
  • set_logging_level()
  • test_mol()
• scifysim.n_air module
  • compile_table()
  • get_Pco2()
  • get_Ph2o()
  • get_n_CO2()
  • get_n_air()
  • get_pvsat_buck()
  • m2thz()
  • n_air()
  • n_h2o()
  • n_hat2nm1()
  • r_index_DA()
  • r_index_air()
  • r_index_co2()
  • r_index_h2o()
  • set_logging_level()
  • test_air()
  • test_h2o()
  • thz2m()
  • wet_atmo
• scifysim.observatory module
  • ObservatoryAltAz
  • SpaceObservatory
  • basic_interpolation()
  • basic_z_rotation()
  • logit
  • observatory
  • test_observatory()
• scifysim.parsefile module
  • getarray()
  • getdate()
  • list_all()
  • parse_file()
• scifysim.plot_tools module
  • getcolor()
  • getcolortrace()
  • make_cursor()
  • piston2size()
  • plot_colored_uv()
  • plot_corrector_tuning_angel_woolf()
  • plot_differential_map()
  • plot_injection()
  • plot_multiple_maps()
  • plot_opds()
  • plot_output_sources()
  • plot_phasescreen()
  • plot_projected_pupil()
  • plot_projected_uv()
  • plot_pupil()
  • plot_response_map()
• scifysim.sources module
  • ABmag2Jy()
  • Jy2ABmag()
  • _blackbody
  • chain()
  • distant_blackbody()
  • enclosure
  • exozodi_simple
  • flux_bin2mag()
  • group
  • mag2flux_bin()
  • magT2flux_bin()
  • resolved_source
  • set_sink()
  • set_source()
  • source
  • src_extended
  • star_planet_target
  • transmission_emission
  • vega_flux_bin()
• scifysim.spectrograph module
  • basic_integrator
  • integrator
  • spectrograph
• scifysim.utilities module
  • Cauchy()
  • Gauss()
  • coeff()
  • ee
  • eval_perf()
  • extract_diffobs_map()
  • extract_diffobs_map_old()
  • find_best_night()
  • fit_distribution()
  • get_bincenters()
  • get_header_bl_data()
  • get_index_pos()
  • get_location()
  • get_raw_array()
  • get_star_params()
  • get_star_params_GAIA_JMMC()
  • get_uv()
  • lambdifyz()
  • loadGRA4MAT()
  • mag2sig()
  • matchseries()
  • parameters2latex()
  • parameters2table()
  • prepare_all()
  • produce_maps()
  • profileit()
  • random_series_fft()
  • range2R()
  • sp2mod()
  • table2latex()
  • test_ex()
  • test_maps()
  • test_random_series()
  • trois()
  • update_observing_night()
  • update_star_params()
  • vec2diag()
  • wrap_phase()

Other links

• Installing SCIFYsim

• What you need to know

• Index

• Module Index

• Search Page

Building this documentation

Documentation is generated through sphinx. Intialization sequence follows this recipe.

References:

[1]

Ceau et al. (2019), A&A, 630, A120