.. prototype argument list auto-generated by buildargdoc.py 
   any manual edits will be overwritten. Modify header text by 
   editing arglistpreamble.txt 

.. _arglist:

EXOSIMS Prototype Inputs
##########################

EXOSIMS contains a large number of user-settable parameters (either via the
input JSON script or passed directly to the constructors of various modules at
instantiation).  All inputs have associated defaults that are automatically
filled in if not set by the user.

The table below includes a list of all Prototype module inputs.

.. list-table:: Prototype Arguments
    :widths: 25 75
    :header-rows: 1

    * - Argument
      - Modules
    * - ``allowRefueling``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``arange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``bandpass_model``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``bandpass_step``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``binaryleakfilepath``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``BW``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``cachedir``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`, :py:class:`~EXOSIMS.Prototypes.PlanetPhysicalModel.PlanetPhysicalModel`, :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`, :py:class:`~EXOSIMS.Prototypes.ZodiacalLight.ZodiacalLight`, :py:class:`~EXOSIMS.Prototypes.BackgroundSources.BackgroundSources`, :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`, :py:class:`~EXOSIMS.Prototypes.Completeness.Completeness`, :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`, :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`, :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`, :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`, :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`, :py:class:`~EXOSIMS.Prototypes.SurveyEnsemble.SurveyEnsemble`, :py:class:`~EXOSIMS.Prototypes.StarCatalog.StarCatalog`
    * - ``charMargin``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``checkInputs``
      - :py:class:`~EXOSIMS.MissionSim.MissionSim`
    * - ``checkKeepoutEnd``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``cherryPickStars``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``coMass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``commonSystemnEZ``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``commonSystemPlane``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``commonSystemPlaneParams``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``constrainOrbits``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``constTOF``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``contrast_floor``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``core_contrast``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``core_platescale``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``core_platescale_units``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``core_thruput``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``csv_angsep_colname``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``debug_plot_path``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``defaultAddExoplanetObsTime``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``defburnPortion``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``distFill``
      - :py:class:`~EXOSIMS.Prototypes.StarCatalog.StarCatalog`
    * - ``dryMass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``dt_max``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``earths_only``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``emission_coefficient_back``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``emission_coefficient_front``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``erange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``eta``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``explainFiltering``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``external_fuel_mass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``FAdMag0``
      - :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`
    * - ``FAP``
      - :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`
    * - ``fillMissingBandMags``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``fillPhotometry``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``filter_for_char``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``filterBinaries``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``find_known_RV``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``fixedPlanPerStar``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``forceStaticEphem``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``FoV``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``getKnownPlanets``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``idark``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``include_known_RV``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``input_angle_units``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``int_dMag``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``int_WA``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``intCutoff``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``Irange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``IWA``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``ko_dtStep``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``koAngles_Earth``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``koAngles_Moon``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``koAngles_Small``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``koAngles_SolarPanel``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``koAngles_Sun``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``lam``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``lenslSamp``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``logfile``
      - :py:class:`~EXOSIMS.MissionSim.MissionSim`
    * - ``loglevel``
      - :py:class:`~EXOSIMS.MissionSim.MissionSim`
    * - ``lucky_planets``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``magEZ``
      - :py:class:`~EXOSIMS.Prototypes.ZodiacalLight.ZodiacalLight`
    * - ``magZ``
      - :py:class:`~EXOSIMS.Prototypes.ZodiacalLight.ZodiacalLight`
    * - ``make_debug_bird_plots``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``massLuminosityRelationship``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``maxdVpct``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``MDP``
      - :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`
    * - ``Min``
      - :py:class:`~EXOSIMS.Prototypes.SimulatedUniverse.SimulatedUniverse`
    * - ``minComp``
      - :py:class:`~EXOSIMS.Prototypes.Completeness.Completeness`
    * - ``missionLife``
      - :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`
    * - ``missionPortion``
      - :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`
    * - ``missionSchedule``
      - :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`
    * - ``missionStart``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`, :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`
    * - ``Mprange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``nofZ``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``nokoMap``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``non_lambertian_coefficient_back``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``non_lambertian_coefficient_front``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``nopar``
      - :py:class:`~EXOSIMS.MissionSim.MissionSim`
    * - ``nreflection_coefficient``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``ntargs``
      - :py:class:`~EXOSIMS.Prototypes.StarCatalog.StarCatalog`
    * - ``ntFlux``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``nVisitsMax``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``OBduration``
      - :py:class:`~EXOSIMS.Prototypes.TimeKeeping.TimeKeeping`
    * - ``obscurFac``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``observingModes``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``occ_dtmax``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``occ_dtmin``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``occ_trans``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``occulterSep``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``ohTime``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``optics``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``optional_filters``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``Orange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``OWA``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``pixelNumber``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``pixelScale``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``pixelSize``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``popStars``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``ppFact``
      - :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`
    * - ``ppFact_char``
      - :py:class:`~EXOSIMS.Prototypes.PostProcessing.PostProcessing`
    * - ``prange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``pupilDiam``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``QE``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``record_counts_path``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``revisit_wait``
      - :py:class:`~EXOSIMS.Prototypes.SurveySimulation.SurveySimulation`
    * - ``Rprange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``Rs``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``scaleOrbits``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`
    * - ``scaleWAdMag``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``scienceInstruments``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``scMass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``settlingTime``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``shapeFac``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``sk_Tmax``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``sk_Tmin``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``skEff``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``skipSaturationCalcs``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``skIsp``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``skMass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``slewEff``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``slewIsp``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``slewMass``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``SNR``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``specular_reflection_factor``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``spkpath``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``sread``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``SRP``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``stabilityFact``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``starlightSuppressionSystems``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``staticStars``
      - :py:class:`~EXOSIMS.Prototypes.TargetList.TargetList`
    * - ``texp``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``texp_flag``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``thrust``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``timeMultiplier``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``twotanks``
      - :py:class:`~EXOSIMS.Prototypes.Observatory.Observatory`
    * - ``use_core_thruput_for_ez``
      - :py:class:`~EXOSIMS.Prototypes.OpticalSystem.OpticalSystem`
    * - ``varEZ``
      - :py:class:`~EXOSIMS.Prototypes.ZodiacalLight.ZodiacalLight`
    * - ``verbose``
      - :py:class:`~EXOSIMS.MissionSim.MissionSim`
    * - ``VmagFill``
      - :py:class:`~EXOSIMS.Prototypes.StarCatalog.StarCatalog`
    * - ``whichPlanetPhaseFunction``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPhysicalModel.PlanetPhysicalModel`
    * - ``wrange``
      - :py:class:`~EXOSIMS.Prototypes.PlanetPopulation.PlanetPopulation`