Welcome to mesalab’s documentation!

This documentation provides an overview of the mesalab package, its functionalities, and how to use it for analyzing MESA and GYRE stellar evolution data.

Contents

• About mesalab
  • About this Documentation
• Installation
  • Using venv (Recommended for most Python-only projects)
  • Using Mamba or Conda (Recommended for complex environments)
  • Install from pip
  • Building from source
  • Unit test
• Getting Started
  • Running mesalab
    • Required Directory Structure
  • Command-line Flags
    • I/O Configuration
    • Blue Loop Analyzis Settings
    • Plot Settings
    • GYRE Workflow Settings
    • RSP Workflow Settings
  • Understanding the YAML Configuration

Using mesalab

• Overview of mesalab Workflows
  • The Analysis Flow
• MESA Run Analysis Workflow
  • Purpose
  • Input
  • Output
  • Configuration Parameters
  • Running this Workflow Independently
• Plotting Workflow
  • Purpose
  • Input
  • Image Files
  • Configuration Parameters
    • 1. plotting_settings section (Workflow Toggles)
    • 2. plot_config section (Visual Style Overrides)
  • Controlling Plot Generation
• GYRE Workflow
  • Purpose
  • Input
  • Output
  • Configuration Parameters
  • Pre-requisites
  • Running this Workflow Independently
• RSP Workflow
  • Purpose
  • Input
  • Output
  • Configuration Parameters
  • Pre-requisites
  • Running the Workflow

Tutorials

• Tutorial 1: Analyzing example grids: MIST synthetic: example/MIST_synthetic
  • Run MIST synthetic example
• Tutorial 2.: Running an Example Analysis in mesalab with Google Colab
  • Prerequisites
    • 1. Set up mesalab and Get Example Data
    • 2. Examine the Example Data and Configuration
    • 3. Run the MESA_grid Example
• Tutorial 3: Running GYRE and RSP with mesalab: example/MESA_grid_gyre, example/MESA_grid_gyre
  • MESA Grid dataset
  • Run MESA grid example with GYRE
    • Understanding GYRE Output
  • Run MESA grid example with RSP
    • Understanding RSP Output

Troubleshooting

• Troubleshooting, Known Issues
  • There are ‘????’ Characters in the Progress Bar
    • 1. Check and Fix Your Terminal’s locale Setting
    • 2. Check Your Terminal Emulator and Font
  • Missing Optional Dependencies (Holoviews, PyMultiNest)
  • FutureWarning: “isochrones” and “pandas”
  • GYRE Workflow Skipped or Failed
  • RSP Workflow Skipped or Failed

Getting Help/Reporting Issues

• Getting Help and Reporting Issues

API

• API Reference
  • Preprocessing Data
    • MESA Grid Directory Scanner
      • analyze_mesa_grid_directory()
    • Data Reader Module
      • extract_params_from_inlist()
      • scan_mesa_runs()
      • get_data_from_history_file()
    • Data Analysis Performer
      • perform_mesa_analysis()
  • Analyze Blue Loop Crossing
    • Blue loop Analyzer and Cross Counter
      • safe_duration()
      • is_in_instability_strip()
      • compute_true_instability_duration()
      • analyze_blue_loop_and_instability()
    • Blue loop CMD Plotting and Bolometric Corrections
      • z_to_feh()
      • generate_blue_loop_plots_with_bc()
      • load_and_group_data()
  • I/O & Configuration
    • YAML Configuration File Parser
      • deep_update()
      • parsing_options()
    • MESA inlist Parser
      • get_mesa_params_from_inlist()
    • Output Manager
      • create_output_directories()
      • get_analysis_file_paths()
  • Visualizaton Tools
    • Plotting Utilities
      • handle_heatmap_generation()
      • handle_blue_loop_bc_plotting()
      • handle_hr_diagram_generation()
      • generate_heatmaps_and_time_diff_csv()
    • HRD Plotter
      • generate_all_hr_diagrams()
  • GYRE Workflow
    • run_gyre_workflow()
    • run_single_gyre_model()
  • RSP Workflow
    • generate_mesa_rsp_inlists()
    • run_mesa_rsp_single()
    • run_mesa_rsp_workflow()