Reference

This section is to provide specific detail for when you know what you’re looking for.

Useful starting places:

• pint.toa - Reading, manipulating, and writing TOAs objects

• pint.models.model_builder.get_model() - Loading TimingModel objects

• pint.models.timing_model.TimingModel - Working with TimingModel objects

• pint.fitter - Fitter objects

• Timing Models
  • Supported Parameters
• Observatory List
• Command-line tools
  • pintk
  • convert_parfile
  • pintbary
  • pintempo
  • zima
  • photonphase
  • fermiphase
  • event_optimize
  • tcb2tdb
• API reference
  • pint.print_info
    • print_info()
  • pint.bayesian
    • pint.bayesian.BayesianTiming
  • pint.binaryconvert
    • pint.binaryconvert.convert_binary
  • pint.config
    • pint.config.datadir
    • pint.config.examplefile
    • pint.config.runtimefile
  • pint.derived_quantities
    • pint.derived_quantities.a1sini
    • pint.derived_quantities.companion_mass
    • pint.derived_quantities.dispersion_slope
    • pint.derived_quantities.dr
    • pint.derived_quantities.dth
    • pint.derived_quantities.gamma
    • pint.derived_quantities.mass_funct
    • pint.derived_quantities.mass_funct2
    • pint.derived_quantities.omdot
    • pint.derived_quantities.omdot_to_mtot
    • pint.derived_quantities.p_to_f
    • pint.derived_quantities.pbdot
    • pint.derived_quantities.pferrs
    • pint.derived_quantities.pulsar_B
    • pint.derived_quantities.pulsar_B_lightcyl
    • pint.derived_quantities.pulsar_age
    • pint.derived_quantities.pulsar_edot
    • pint.derived_quantities.pulsar_mass
    • pint.derived_quantities.shklovskii_factor
    • pint.derived_quantities.sini
  • pint.erfautils
    • pint.erfautils.gcrs_posvel_from_itrf
  • pint.event_toas
    • get_NuSTAR_TOAs()
    • get_NICER_TOAs()
    • get_RXTE_TOAs()
    • get_IXPE_TOAs()
    • get_Swift_TOAs()
    • get_XMM_TOAs()
    • load_NuSTAR_TOAs()
    • load_NICER_TOAs()
    • load_RXTE_TOAs()
    • load_IXPE_TOAs()
    • load_Swift_TOAs()
    • load_XMM_TOAs()
    • pint.event_toas.check_timeref
    • pint.event_toas.check_timesys
    • pint.event_toas.create_mission_config
    • pint.event_toas.get_event_TOAs
    • pint.event_toas.get_fits_TOAs
    • pint.event_toas.load_event_TOAs
    • pint.event_toas.load_fits_TOAs
    • pint.event_toas.read_mission_info_from_heasoft
  • pint.eventstats
    • pint.eventstats.best_m
    • pint.eventstats.cosm
    • pint.eventstats.em_four
    • pint.eventstats.em_lc
    • pint.eventstats.from_array
    • pint.eventstats.h2sig
    • pint.eventstats.hm
    • pint.eventstats.hmw
    • pint.eventstats.sf_h20_dj2010
    • pint.eventstats.sf_hm
    • pint.eventstats.sf_stackedh
    • pint.eventstats.sf_z2m
    • pint.eventstats.sig2h20
    • pint.eventstats.sig2sigma
    • pint.eventstats.sigma2sig
    • pint.eventstats.sigma_trials
    • pint.eventstats.to_array
    • pint.eventstats.vec
    • pint.eventstats.z2m
    • pint.eventstats.z2mw
  • pint.extern
  • pint.fermi_toas
    • pint.fermi_toas.calc_lat_weights
    • pint.fermi_toas.get_Fermi_TOAs
    • pint.fermi_toas.load_Fermi_TOAs
  • pint.fits_utils
    • pint.fits_utils.read_fits_event_mjds
    • pint.fits_utils.read_fits_event_mjds_tuples
  • pint.fitter
    • pint.fitter.DownhillFitter
    • pint.fitter.DownhillGLSFitter
    • pint.fitter.DownhillWLSFitter
    • pint.fitter.Fitter
    • pint.fitter.GLSFitter
    • pint.fitter.GLSState
    • pint.fitter.LMFitter
    • pint.fitter.ModelState
    • pint.fitter.PowellFitter
    • pint.fitter.WLSFitter
    • pint.fitter.WLSState
    • pint.fitter.WidebandDownhillFitter
    • pint.fitter.WidebandLMFitter
    • pint.fitter.WidebandState
    • pint.fitter.WidebandTOAFitter
    • pint.fitter.ConvergenceFailure
    • pint.fitter.CorrelatedErrors
    • pint.fitter.DegeneracyWarning
    • pint.fitter.InvalidModelParameters
    • pint.fitter.MaxiterReached
    • pint.fitter.StepProblem
  • pint.gridutils
    • pint.gridutils.doonefit
    • pint.gridutils.grid_chisq
    • pint.gridutils.grid_chisq_derived
    • pint.gridutils.hostinfo
    • pint.gridutils.set_log
    • pint.gridutils.tuple_chisq
    • pint.gridutils.tuple_chisq_derived
    • pint.gridutils.WrappedFitter
  • pint.logging
    • pint.logging.get_level
    • pint.logging.setup
    • pint.logging.showwarning
    • pint.logging.LogFilter
  • pint.mcmc_fitter
    • pint.mcmc_fitter.concat_toas
    • pint.mcmc_fitter.lnlikelihood_basic
    • pint.mcmc_fitter.lnlikelihood_chi2
    • pint.mcmc_fitter.lnprior_basic
    • pint.mcmc_fitter.set_priors_basic
    • pint.mcmc_fitter.CompositeMCMCFitter
    • pint.mcmc_fitter.MCMCFitter
    • pint.mcmc_fitter.MCMCFitterAnalyticTemplate
    • pint.mcmc_fitter.MCMCFitterBinnedTemplate
  • pint.models
    • pint.models.absolute_phase
    • pint.models.astrometry
    • pint.models.binary_bt
    • pint.models.binary_dd
    • pint.models.binary_ddk
    • pint.models.binary_ell1
    • pint.models.dispersion_model
    • pint.models.dmwavex
    • pint.models.fdjump
    • pint.models.frequency_dependent
    • pint.models.glitch
    • pint.models.ifunc
    • pint.models.jump
    • pint.models.model_builder
    • pint.models.noise_model
    • pint.models.parameter
    • pint.models.phase_offset
    • pint.models.piecewise
    • pint.models.priors
    • pint.models.pulsar_binary
    • pint.models.solar_system_shapiro
    • pint.models.solar_wind_dispersion
    • pint.models.spindown
    • pint.models.stand_alone_psr_binaries
    • pint.models.tcb_conversion
    • pint.models.timing_model
    • pint.models.troposphere_delay
    • pint.models.wave
    • pint.models.wavex
  • pint.modelutils
    • pint.modelutils.model_ecliptic_to_equatorial
    • pint.modelutils.model_equatorial_to_ecliptic
  • pint.observatory
    • pint.observatory.compare_t2_observatories_dat
    • pint.observatory.compare_tempo_obsys_dat
    • pint.observatory.earth_location_distance
    • pint.observatory.find_clock_file
    • pint.observatory.get_observatory
    • pint.observatory.list_last_correction_mjds
    • pint.observatory.update_clock_files
    • pint.observatory.Observatory
    • pint.observatory.ClockCorrectionError
    • pint.observatory.ClockCorrectionOutOfRange
    • pint.observatory.NoClockCorrections
    • pint.observatory.clock_file
    • pint.observatory.global_clock_corrections
    • pint.observatory.satellite_obs
    • pint.observatory.special_locations
    • pint.observatory.topo_obs
  • pint.orbital
    • pint.orbital.kepler
  • pint.phase
    • pint.phase.Phase
  • pint.pint_matrix
    • pint.pint_matrix.combine_covariance_matrix
    • pint.pint_matrix.combine_design_matrices_by_param
    • pint.pint_matrix.combine_design_matrices_by_quantity
    • pint.pint_matrix.CorrelationMatrix
    • pint.pint_matrix.CovarianceMatrix
    • pint.pint_matrix.CovarianceMatrixMaker
    • pint.pint_matrix.DesignMatrix
    • pint.pint_matrix.DesignMatrixMaker
    • pint.pint_matrix.NoiseDesignMatrixMaker
    • pint.pint_matrix.PhaseDesignMatrixMaker
    • pint.pint_matrix.PintMatrix
    • pint.pint_matrix.TOADesignMatrixMaker
  • pint.pintk
    • pint.pintk.colormodes
    • pint.pintk.paredit
    • pint.pintk.plk
    • pint.pintk.pulsar
    • pint.pintk.timedit
  • pint.plot_utils
    • pint.plot_utils.phaseogram
    • pint.plot_utils.phaseogram_binned
    • pint.plot_utils.plot_priors
  • pint.polycos
    • pint.polycos.tempo_polyco_table_reader
    • pint.polycos.tempo_polyco_table_writer
    • pint.polycos.tqdm
    • pint.polycos.PolycoEntry
    • pint.polycos.Polycos
  • pint.pulsar_ecliptic
    • pint.pulsar_ecliptic.icrs_to_pulsarecliptic
    • pint.pulsar_ecliptic.load_obliquity_file
    • pint.pulsar_ecliptic.pulsarecliptic_to_icrs
    • pint.pulsar_ecliptic.pulsarecliptic_to_pulsarecliptic
    • pint.pulsar_ecliptic.PulsarEcliptic
  • pint.pulsar_mjd
    • pint.pulsar_mjd.data2longdouble
    • pint.pulsar_mjd.day_frac
    • pint.pulsar_mjd.fortran_float
    • pint.pulsar_mjd.jds_to_mjds
    • pint.pulsar_mjd.jds_to_mjds_pulsar
    • pint.pulsar_mjd.longdouble2str
    • pint.pulsar_mjd.mjds_to_jds
    • pint.pulsar_mjd.mjds_to_jds_pulsar
    • pint.pulsar_mjd.mjds_to_str
    • pint.pulsar_mjd.quantity2longdouble_withunit
    • pint.pulsar_mjd.safe_kind_conversion
    • pint.pulsar_mjd.split
    • pint.pulsar_mjd.str2longdouble
    • pint.pulsar_mjd.str_to_mjds
    • pint.pulsar_mjd.time_from_longdouble
    • pint.pulsar_mjd.time_from_mjd_string
    • pint.pulsar_mjd.time_to_longdouble
    • pint.pulsar_mjd.time_to_mjd_string
    • pint.pulsar_mjd.two_product
    • pint.pulsar_mjd.two_sum
    • pint.pulsar_mjd.MJDLong
    • pint.pulsar_mjd.MJDString
    • pint.pulsar_mjd.PulsarMJD
    • pint.pulsar_mjd.PulsarMJDLong
    • pint.pulsar_mjd.PulsarMJDString
  • pint.random_models
    • pint.random_models.random_models
  • pint.residuals
    • pint.residuals.CombinedResiduals
    • pint.residuals.Residuals
    • pint.residuals.WidebandDMResiduals
    • pint.residuals.WidebandTOAResiduals
  • pint.sampler
    • pint.sampler.EmceeSampler
    • pint.sampler.MCMCSampler
  • pint.scripts
    • pint.scripts.compare_parfiles
    • pint.scripts.convert_parfile
    • pint.scripts.event_optimize
    • pint.scripts.event_optimize_MCMCFitter
    • pint.scripts.event_optimize_multiple
    • pint.scripts.fermiphase
    • pint.scripts.photonphase
    • pint.scripts.pintbary
    • pint.scripts.pintempo
    • pint.scripts.pintk
    • pint.scripts.pintpublish
    • pint.scripts.tcb2tdb
    • pint.scripts.zima
  • pint.simulation
    • pint.simulation.calculate_random_models
    • pint.simulation.get_fake_toa_clock_versions
    • pint.simulation.make_fake_toas
    • pint.simulation.make_fake_toas_fromMJDs
    • pint.simulation.make_fake_toas_fromtim
    • pint.simulation.make_fake_toas_uniform
    • pint.simulation.update_fake_dms
    • pint.simulation.zero_residuals
  • pint.solar_system_ephemerides
    • pint.solar_system_ephemerides.get_tdb_tt_ephem_geocenter
    • pint.solar_system_ephemerides.load_kernel
    • pint.solar_system_ephemerides.objPosVel
    • pint.solar_system_ephemerides.objPosVel_wrt_SSB
  • pint.templates
    • pint.templates.lcenorm
    • pint.templates.lceprimitives
    • pint.templates.lcfitters
    • pint.templates.lcnorm
    • pint.templates.lcprimitives
    • pint.templates.lctemplate
  • pint.toa
    • pint.toa.build_table
    • pint.toa.format_toa_line
    • pint.toa.get_TOAs
    • pint.toa.get_TOAs_array
    • pint.toa.get_TOAs_list
    • pint.toa.load_pickle
    • pint.toa.merge_TOAs
    • pint.toa.read_toa_file
    • pint.toa.save_pickle
    • pint.toa.FlagDict
    • pint.toa.TOA
    • pint.toa.TOAs
  • pint.toa_select
    • pint.toa_select.TOASelect
  • pint.utils
    • pint.utils.ELL1_check
    • pint.utils.FTest
    • pint.utils.add_dummy_distance
    • pint.utils.akaike_information_criterion
    • pint.utils.check_all_partials
    • pint.utils.check_longdouble_precision
    • pint.utils.colorize
    • pint.utils.compute_hash
    • pint.utils.convert_dispersion_measure
    • pint.utils.divide_times
    • pint.utils.dmwavex_setup
    • pint.utils.dmx_ranges
    • pint.utils.dmx_ranges_old
    • pint.utils.dmxparse
    • pint.utils.dmxselections
    • pint.utils.dmxstats
    • pint.utils.find_optimal_nharms
    • pint.utils.find_prefix_bytime
    • pint.utils.get_conjunction
    • pint.utils.get_prefix_timerange
    • pint.utils.get_prefix_timeranges
    • pint.utils.get_unit
    • pint.utils.get_wavex_amps
    • pint.utils.get_wavex_freqs
    • pint.utils.group_iterator
    • pint.utils.has_astropy_unit
    • pint.utils.info_string
    • pint.utils.interesting_lines
    • pint.utils.lines_of
    • pint.utils.list_parameters
    • pint.utils.merge_dmx
    • pint.utils.normalize_designmatrix
    • pint.utils.numeric_partial
    • pint.utils.numeric_partials
    • pint.utils.open_or_use
    • pint.utils.parse_time
    • pint.utils.pldmnoise_from_dmwavex
    • pint.utils.plrednoise_from_wavex
    • pint.utils.pmtot
    • pint.utils.print_color_examples
    • pint.utils.remove_dummy_distance
    • pint.utils.require_longdouble_precision
    • pint.utils.sherman_morrison_dot
    • pint.utils.split_dmx
    • pint.utils.split_prefixed_name
    • pint.utils.split_swx
    • pint.utils.taylor_horner
    • pint.utils.taylor_horner_deriv
    • pint.utils.translate_wave_to_wavex
    • pint.utils.translate_wavex_to_wave
    • pint.utils.wavex_setup
    • pint.utils.weighted_mean
    • pint.utils.woodbury_dot
    • pint.utils.xxxselections
    • pint.utils.PosVel
    • pint.utils.dmxrange
    • pint.utils.PINTPrecisionError
    • pint.utils.PrefixError
• PINT coding style