EXOSIMS
  • Introduction
    • Purpose and Scope
    • Framework
    • Terminology
    • Directory Layout
  • Installing and Configuring
    • Obtaining EXOSIMS
    • Environment and Package Dependencies
    • Installation
    • Cache Directory
    • Downloads Directory
    • Compiling Cython Modules
      • KeplerSTM
  • Quick Start Guide
    • EXOSIMS Workflow
      • Creating a MissionSimulation
      • Running a Simulation and Analyzing Results
      • Running Additional Simulations
    • Building Your Own Mission
      • Step 1
      • Step 2
      • Step 3
      • Step 4
      • Step 5
    • Creating Synthetic Universes
    • Generating Keepout Map Data
    • Calculating Integration Time Adjusted Completeness
  • Fundamental Concepts
    • Orbit Geometry
    • Photometry
      • Stellar Photometry
        • Template Spectra
        • Modeling Mid- to Far-IR Instruments
      • Planet Photometry
    • Observing Bands
    • Phase Functions
    • Completeness, Integration Time, and \(\Delta{\textrm{mag}}\)
    • Stellar Diameter
    • Zodiacal Light
    • Exozodiacal Light
  • Module Implementation
    • Module Inheritance and Initialization
    • Module Type
    • Callable Attributes
    • Units
    • Coding Conventions
  • Interface Specification
  • Input Specification
    • Module Specification
    • Keyword Inputs
    • Keywords and Nested Module Initializations
    • Output Specification
    • Input/Output Checking
  • BackgroundSources
  • Completeness
    • Initialization
    • Different Planet Populations for Completeness
  • Observatory
    • Starshades
      • Prototype
        • Prototype - Slew Maneuvers
        • Prototype - Station-Keeping Maneuvers
      • SotoStarshade
        • 0 - Slew Calculations in SotoStarshade
        • 1 - Procedures in next_target
        • 2 - Distinguishing Between Prototype and SotoStarshade
        • 3 - Finding Ranges of Slew Times
        • 4 - Selecting a Slew Time for Each Target
        • 5 - Choosing the Next Target
      • SotoStarshade_SKi
  • OpticalSystem
    • Optical System Definition
      • Science Instruments
        • Required Prototype Instrument Parameters
        • Field of View and Pixel Scale
        • Focal Length and f-Number
        • Photon Counting Detectors
      • Starlight Suppression System
        • Required Prototype Starlight Suppression System Parameters
        • Standardized Coronagraph Parameters
      • Observing Mode
        • Required Prototype Observing Mode Parameters
        • Observing Mode Identification
      • Initialization
    • Optical System Methods
      • Cp_Cb_Csp
      • calc_intTime
      • calc_dMag_per_intTime
      • ddMag_dt
  • PlanetPhysicalModel
  • PlanetPopulation
  • PostProcessing
  • SimulatedUniverse
  • StarCatalog
  • SurveySimulation
  • SurveyEnsemble
    • Prototype
    • IPyParallel
      • run_ipcluster_ensemble
      • read_ipcluster_ensemble
  • TargetList
    • Mass-Luminosity Relationship
  • TimeKeeping
    • Mission End
  • ZodiacalLight
  • EXOSIMS Prototype Inputs
  • Documentation Guide
    • Installing Sphinx
    • Building the docs
    • Rebuilding from Scratch
    • Docstrings
      • Classes
      • Methods
      • Comments
    • Intersphinx
  • Testing
    • End-to-End Testing
    • Unit Testing
  • Utilities
    • MissionSim Utilities
      • genWaypoint
      • checkScript
  • References
  • Glossary
  • EXOSIMS package
    • Subpackages
      • EXOSIMS.BackgroundSources package
        • Submodules
        • EXOSIMS.BackgroundSources.GalaxiesFaintStars module
      • EXOSIMS.Completeness package
        • Submodules
        • EXOSIMS.Completeness.BrownCompleteness module
        • EXOSIMS.Completeness.GarrettCompleteness module
        • EXOSIMS.Completeness.IntegrationTimeAdjustedCompleteness module
        • EXOSIMS.Completeness.SubtypeCompleteness module
      • EXOSIMS.Observatory package
        • Submodules
        • EXOSIMS.Observatory.ObservatoryL2Halo module
        • EXOSIMS.Observatory.SotoStarshade module
        • EXOSIMS.Observatory.SotoStarshade_ContThrust module
        • EXOSIMS.Observatory.SotoStarshade_SKi module
        • EXOSIMS.Observatory.SotoStarshade_parallel module
        • EXOSIMS.Observatory.WFIRSTObservatoryL2 module
      • EXOSIMS.OpticalSystem package
        • Submodules
        • EXOSIMS.OpticalSystem.KasdinBraems module
        • EXOSIMS.OpticalSystem.Nemati module
        • EXOSIMS.OpticalSystem.Nemati_2019 module
      • EXOSIMS.PlanetPhysicalModel package
        • Submodules
        • EXOSIMS.PlanetPhysicalModel.Forecaster module
        • EXOSIMS.PlanetPhysicalModel.ForecasterMod module
        • EXOSIMS.PlanetPhysicalModel.FortneyMarleyCahoyMix1 module
      • EXOSIMS.PlanetPopulation package
        • Submodules
        • EXOSIMS.PlanetPopulation.AlbedoByRadius module
        • EXOSIMS.PlanetPopulation.AlbedoByRadiusDulzPlavchan module
        • EXOSIMS.PlanetPopulation.Brown2005EarthLike module
        • EXOSIMS.PlanetPopulation.DulzPlavchan module
        • EXOSIMS.PlanetPopulation.EarthTwinHabZone1 module
        • EXOSIMS.PlanetPopulation.EarthTwinHabZone1SDET module
        • EXOSIMS.PlanetPopulation.EarthTwinHabZone2 module
        • EXOSIMS.PlanetPopulation.EarthTwinHabZone3 module
        • EXOSIMS.PlanetPopulation.EarthTwinHabZoneSDET module
        • EXOSIMS.PlanetPopulation.Guimond2019 module
        • EXOSIMS.PlanetPopulation.JupiterTwin module
        • EXOSIMS.PlanetPopulation.KeplerLike1 module
        • EXOSIMS.PlanetPopulation.KeplerLike2 module
        • EXOSIMS.PlanetPopulation.KnownRVPlanets module
        • EXOSIMS.PlanetPopulation.SAG13 module
        • EXOSIMS.PlanetPopulation.SolarSystem module
      • EXOSIMS.PostProcessing package
        • Submodules
        • EXOSIMS.PostProcessing.PostProcessing2 module
      • EXOSIMS.Prototypes package
        • Submodules
        • EXOSIMS.Prototypes.BackgroundSources module
        • EXOSIMS.Prototypes.Completeness module
        • EXOSIMS.Prototypes.Observatory module
        • EXOSIMS.Prototypes.OpticalSystem module
        • EXOSIMS.Prototypes.PlanetPhysicalModel module
        • EXOSIMS.Prototypes.PlanetPopulation module
        • EXOSIMS.Prototypes.PostProcessing module
        • EXOSIMS.Prototypes.SimulatedUniverse module
        • EXOSIMS.Prototypes.StarCatalog module
        • EXOSIMS.Prototypes.SurveyEnsemble module
        • EXOSIMS.Prototypes.SurveySimulation module
        • EXOSIMS.Prototypes.TargetList module
        • EXOSIMS.Prototypes.TimeKeeping module
        • EXOSIMS.Prototypes.ZodiacalLight module
      • EXOSIMS.SimulatedUniverse package
        • Submodules
        • EXOSIMS.SimulatedUniverse.DulzPlavchanUniverse module
        • EXOSIMS.SimulatedUniverse.DulzPlavchanUniverseEarthsOnly module
        • EXOSIMS.SimulatedUniverse.KeplerLikeUniverse module
        • EXOSIMS.SimulatedUniverse.KnownRVPlanetsUniverse module
        • EXOSIMS.SimulatedUniverse.SAG13Universe module
        • EXOSIMS.SimulatedUniverse.SolarSystemUniverse module
      • EXOSIMS.StarCatalog package
        • Submodules
        • EXOSIMS.StarCatalog.EXOCAT1 module
        • EXOSIMS.StarCatalog.FakeCatalog module
        • EXOSIMS.StarCatalog.FakeCatalog_UniformAngles module
        • EXOSIMS.StarCatalog.FakeCatalog_UniformSpacing_wInput module
        • EXOSIMS.StarCatalog.GaiaCat1 module
        • EXOSIMS.StarCatalog.HIPfromSimbad module
        • EXOSIMS.StarCatalog.HWOMissionStars module
        • EXOSIMS.StarCatalog.SIMBAD300Catalog module
        • EXOSIMS.StarCatalog.SIMBADCatalog module
      • EXOSIMS.SurveyEnsemble package
        • Submodules
        • EXOSIMS.SurveyEnsemble.IPClusterEnsemble module
      • EXOSIMS.SurveySimulation package
        • Submodules
        • EXOSIMS.SurveySimulation.KnownRVSurvey module
        • EXOSIMS.SurveySimulation.SLSQPScheduler module
        • EXOSIMS.SurveySimulation.cbytScheduler module
        • EXOSIMS.SurveySimulation.coroOnlyScheduler module
        • EXOSIMS.SurveySimulation.linearJScheduler module
        • EXOSIMS.SurveySimulation.linearJScheduler_3DDPC module
        • EXOSIMS.SurveySimulation.linearJScheduler_DDPC module
        • EXOSIMS.SurveySimulation.linearJScheduler_det_only module
        • EXOSIMS.SurveySimulation.linearJScheduler_orbitChar module
        • EXOSIMS.SurveySimulation.occulterJScheduler module
        • EXOSIMS.SurveySimulation.randomWalkScheduler module
        • EXOSIMS.SurveySimulation.randomWalkScheduler2 module
        • EXOSIMS.SurveySimulation.tieredScheduler module
        • EXOSIMS.SurveySimulation.tieredScheduler_DD module
      • EXOSIMS.TargetList package
        • Submodules
        • EXOSIMS.TargetList.EclipticTargetList module
        • EXOSIMS.TargetList.GaiaCatTargetList module
        • EXOSIMS.TargetList.KnownRVPlanetsTargetList module
      • EXOSIMS.TimeKeeping package
      • EXOSIMS.ZodiacalLight package
        • Submodules
        • EXOSIMS.ZodiacalLight.Mennesson module
        • EXOSIMS.ZodiacalLight.Stark module
      • EXOSIMS.util package
        • Subpackages
        • Submodules
        • EXOSIMS.util.CheckScript module
        • EXOSIMS.util.InverseTransformSampler module
        • EXOSIMS.util.RejectionSampler module
        • EXOSIMS.util.csv_fix module
        • EXOSIMS.util.deltaMag module
        • EXOSIMS.util.eccanom module
        • EXOSIMS.util.fakeMultiRunAnalysis module
        • EXOSIMS.util.fakeSingleRunAnalysis module
        • EXOSIMS.util.getExoplanetArchive module
        • EXOSIMS.util.get_dirs module
        • EXOSIMS.util.get_module module
        • EXOSIMS.util.input_script_check module
        • EXOSIMS.util.keplerSTM module
        • EXOSIMS.util.keplerSTM_indprop module
        • EXOSIMS.util.keyword_fun module
        • EXOSIMS.util.makeSimilarScripts module
        • EXOSIMS.util.maxConsecutiveTrue module
        • EXOSIMS.util.memoize module
        • EXOSIMS.util.partitionSphere module
        • EXOSIMS.util.phaseFunctions module
        • EXOSIMS.util.photometricModels module
        • EXOSIMS.util.planet_star_separation module
        • EXOSIMS.util.process_opticalsys_package module
        • EXOSIMS.util.radialfun module
        • EXOSIMS.util.read_ipcluster_ensemble module
        • EXOSIMS.util.statsFun module
        • EXOSIMS.util.utils module
        • EXOSIMS.util.vprint module
        • EXOSIMS.util.waypoint module
    • Submodules
    • EXOSIMS.MissionSim module
      • MissionSim
        • MissionSim.StarCatalog
        • MissionSim.PlanetPopulation
        • MissionSim.PlanetPhysicalModel
        • MissionSim.OpticalSystem
        • MissionSim.ZodiacalLight
        • MissionSim.BackgroundSources
        • MissionSim.PostProcessing
        • MissionSim.Completeness
        • MissionSim.TargetList
        • MissionSim.SimulatedUniverse
        • MissionSim.Observatory
        • MissionSim.TimeKeeping
        • MissionSim.SurveySimulation
        • MissionSim.SurveyEnsemble
        • MissionSim.modules
        • MissionSim.verbose
        • MissionSim.seed
        • MissionSim.logfile
        • MissionSim.loglevel
        • MissionSim.DRM2array()
        • MissionSim.checkScript()
        • MissionSim.check_ioscripts()
        • MissionSim.filter_status()
        • MissionSim.genOutSpec()
        • MissionSim.genWaypoint()
        • MissionSim.get_logger()
        • MissionSim.reset_sim()
        • MissionSim.run_ensemble()
        • MissionSim.run_sim()
    • EXOSIMS.e2eTests module
      • run_e2e_tests()
EXOSIMS
  • Search

© Copyright 2015 - 2023, SIOSlab.

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