AstroQ

Contents:

  • Getting Started
    • Installation
      • Installing Gurobi
      • Installing AstroQ
      • Installation Test
    • Required Files
    • Command Line Interface
    • Hello World Example
  • OB Construction
  • Modules
    • access
      • Access
        • Access.compute_allocated()
        • Access.compute_altaz()
        • Access.compute_clear()
        • Access.compute_custom()
        • Access.compute_future()
        • Access.compute_inter()
        • Access.compute_moon()
        • Access.get_loss_stats()
        • Access.observability()
        • Access.produce_ultimate_map()
        • Access.simulate_weather_losses()
      • build_twilight_allocation_file()
    • benchmarking
      • build_toy_model_from_paper()
      • getDec()
      • stars_in_program()
    • kpfcc.py
      • Access_KPFCC
        • Access_KPFCC.compute_allocated()
        • Access_KPFCC.compute_altaz()
        • Access_KPFCC.compute_clear()
        • Access_KPFCC.compute_custom()
        • Access_KPFCC.compute_future()
        • Access_KPFCC.compute_inter()
        • Access_KPFCC.compute_moon()
        • Access_KPFCC.get_loss_stats()
        • Access_KPFCC.observability()
        • Access_KPFCC.produce_ultimate_map()
        • Access_KPFCC.simulate_weather_losses()
      • _validate_datetime_format()
      • analyze_bad_obs()
      • apply_safety_valves()
      • cast_columns()
      • compute_exposure_info()
      • create_checks_dataframes()
      • filter_request_csv()
      • flatten()
      • format_custom_csv()
      • format_keck_allocation_info()
      • format_kpf_row()
      • get_request_sheet()
      • inspect_row()
      • load_fit_results_h5()
      • plot_bad_obs_histograms()
      • pm_correcter()
      • pull_OB_histories()
      • pull_OBs()
      • pull_allocation_info()
      • recompute_exposure_times()
      • sort_good_bad()
      • update_allocation_file()
      • validate_and_convert_coordinates()
      • write_starlist()
    • cli.py
      • main()
    • driver.py
      • bench()
      • kpfcc_prep()
      • kpfcc_webapp()
      • plan_night()
      • plan_semester()
      • plot()
      • requests_vs_schedule()
    • history
      • StarHistory
        • StarHistory._asdict()
        • StarHistory._field_defaults
        • StarHistory._fields
        • StarHistory._make()
        • StarHistory._replace()
        • StarHistory.count()
        • StarHistory.date_last_observed
        • StarHistory.exposure_start_times
        • StarHistory.index()
        • StarHistory.n_obs_on_nights
        • StarHistory.n_visits_on_nights
        • StarHistory.name
        • StarHistory.total_n_exposures
        • StarHistory.total_n_unique_nights
        • StarHistory.total_n_visits
        • StarHistory.total_open_shutter_time
      • _exposure_ut_column()
      • _local_datetime_from_ut()
      • _make_observer()
      • _night_of_key_from_cell()
      • local_time_str_from_ut()
      • night_of_date_from_sunset()
      • process_star_history()
      • write_OB_histories_to_csv()
    • io
      • build_fullness_report()
      • compute_program_statistics()
      • format_kpf_row()
      • pm_correcter()
      • serialize_schedule()
      • write_starlist()
    • nplan
      • NightPlanner
        • NightPlanner.from_hdf5()
        • NightPlanner.get_first_last_indices()
        • NightPlanner.run_ttp()
        • NightPlanner.to_hdf5()
      • get_nightly_times_from_allocation()
    • plot.py
      • StarPlotter
        • StarPlotter.get_future()
        • StarPlotter.get_map()
        • StarPlotter.get_past()
        • StarPlotter.get_stats()
      • add_star_links()
      • compute_seasonality()
      • createTelSlewPath()
      • dataframe_to_html()
      • get_birdseye()
      • get_cof()
      • get_football()
      • get_ladder()
      • get_rawobs()
      • get_request_frame()
      • get_script_plan()
      • get_slew_animation_plotly()
      • get_tau_inter_line()
      • get_timebar()
      • get_timebar_by_program()
      • nightplan_table_to_html()
      • past_history_table()
      • plot_path_2D_interactive()
      • process_stars()
      • request_frame_to_html()
    • splan
      • SemesterPlanner
        • SemesterPlanner._build_date_dictionary()
        • SemesterPlanner._build_observability()
        • SemesterPlanner._build_slots_required_dictionary()
        • SemesterPlanner._calculate_slot_info()
        • SemesterPlanner._compute_slots_required_for_exposure()
        • SemesterPlanner.add_twilights()
        • SemesterPlanner.build_model_round1()
        • SemesterPlanner.build_model_round2()
        • SemesterPlanner.constraint_build_enforce_intranight_cadence()
        • SemesterPlanner.constraint_build_theta_multivisit()
        • SemesterPlanner.constraint_enforce_internight_cadence()
        • SemesterPlanner.constraint_fix_previous_objective()
        • SemesterPlanner.constraint_reserve_multislot_exposures()
        • SemesterPlanner.constraint_set_max_absolute_unique_nights_Wrd()
        • SemesterPlanner.constraint_set_max_desired_unique_nights_Wrd()
        • SemesterPlanner.constraint_set_min_max_visits_per_night()
        • SemesterPlanner.constraint_throttle()
        • SemesterPlanner.from_hdf5()
        • SemesterPlanner.optimize_model()
        • SemesterPlanner.remove_constraint_set_max_desired_unique_nights_Wrd()
        • SemesterPlanner.run_model()
        • SemesterPlanner.serialize_results_csv()
        • SemesterPlanner.set_objective_maximize_slots_used()
        • SemesterPlanner.set_objective_minimize_theta_time_normalized()
        • SemesterPlanner.to_hdf5()
    • webapp
      • download_nightplan()
      • dynamic_page()
      • index()
      • launch_app()
      • load_data_for_path()
      • render_admin_page()
      • render_nightplan_page()
      • render_program_page()
      • render_star_page()
      • star_page()
  • cli.py
    • main()
  • driver.py
    • bench()
    • kpfcc_prep()
    • kpfcc_webapp()
    • plan_night()
    • plan_semester()
    • plot()
    • requests_vs_schedule()
  • kpfcc.py
    • Access_KPFCC
      • Access_KPFCC.compute_allocated()
      • Access_KPFCC.compute_altaz()
      • Access_KPFCC.compute_clear()
      • Access_KPFCC.compute_custom()
      • Access_KPFCC.compute_future()
      • Access_KPFCC.compute_inter()
      • Access_KPFCC.compute_moon()
      • Access_KPFCC.get_loss_stats()
      • Access_KPFCC.observability()
      • Access_KPFCC.produce_ultimate_map()
      • Access_KPFCC.simulate_weather_losses()
    • _validate_datetime_format()
    • analyze_bad_obs()
    • apply_safety_valves()
    • cast_columns()
    • compute_exposure_info()
    • create_checks_dataframes()
    • filter_request_csv()
    • flatten()
    • format_custom_csv()
    • format_keck_allocation_info()
    • format_kpf_row()
    • get_request_sheet()
    • inspect_row()
    • load_fit_results_h5()
    • plot_bad_obs_histograms()
    • pm_correcter()
    • pull_OB_histories()
    • pull_OBs()
    • pull_allocation_info()
    • recompute_exposure_times()
    • sort_good_bad()
    • update_allocation_file()
    • validate_and_convert_coordinates()
    • write_starlist()
  • plot.py
    • StarPlotter
      • StarPlotter.get_future()
      • StarPlotter.get_map()
      • StarPlotter.get_past()
      • StarPlotter.get_stats()
    • add_star_links()
    • compute_seasonality()
    • createTelSlewPath()
    • dataframe_to_html()
    • get_birdseye()
    • get_cof()
    • get_football()
    • get_ladder()
    • get_rawobs()
    • get_request_frame()
    • get_script_plan()
    • get_slew_animation_plotly()
    • get_tau_inter_line()
    • get_timebar()
    • get_timebar_by_program()
    • nightplan_table_to_html()
    • past_history_table()
    • plot_path_2D_interactive()
    • process_stars()
    • request_frame_to_html()
AstroQ
  • Overview: module code

All modules for which code is available

  • astroq.access
  • astroq.benchmarking
  • astroq.cli
  • astroq.driver
  • astroq.history
  • astroq.io
  • astroq.nplan
  • astroq.plot
  • astroq.queue.kpfcc
  • astroq.splan
  • astroq.webapp
  • builtins
  • test_sample
  • unittest.case

© Copyright 2025, Jack Lubin, Judah Van Zandt, Erik Petigura.

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