microlens-submit Logo

Contents:

  • CLI Tutorial: A Step-by-Step Guide
    • Prerequisites
    • Learning Objectives
    • Tutorial Contents
    • Step-by-Step Guide
      • 1. Initialize Your Project
      • 2. Record Repository and Hardware Information
      • 3. Add Your First Solution
        • Parameter File Support:
        • Uncertainty Metadata:
      • 4. Bulk Importing Solutions from CSV
        • Example CSVs:
        • Project Management Commands
      • 5. Validate without saving
      • 6. Validate existing solutions
      • 7. Attaching files
        • Posterior samples
        • Plots and visualizations
        • Notes
      • 8. Manage Solutions for the Same Event
        • Add a competing solution
        • Solution Comparison:
        • Editing solution attributes
        • Solution Aliases:
        • Solution Comparison Best Practices:
        • Solution-level hardware overrides (optional):
      • 9. Export the final package
      • 10. Preview your submission dossier
    • Comprehensive Best Practices Guide
      • Reproducibility:
      • Workflow Management:
      • Data Quality:
      • Performance Optimization:
    • Troubleshooting
      • 1. Validation Errors:
      • 2. File Path Issues:
      • 3. Model Type Errors:
      • 4. Export Problems:
    • Getting Help
    • About this Notebook
  • Usage Examples
    • Quick Start
    • Command Line Usage
    • Supported Model Types
    • Higher-Order Effects
    • Extended Example
    • Inspecting Solutions and Resolving Duplicate Aliases (Python API)
    • Solution-Level Hardware Overrides (Python API)
    • Dossier Generation Examples
  • Python API Reference
    • Core Classes
    • Loading and Saving
      • load()
    • Submission Class
      • Submission
        • Submission.autofill_nexus_info()
        • Submission.events
        • Submission.export()
        • Submission.get_event()
        • Submission.get_solution_by_alias()
        • Submission.get_solution_status()
        • Submission.git_dir
        • Submission.hardware_info
        • Submission.model_config
        • Submission.notebook_display_dashboard()
        • Submission.notebook_display_event()
        • Submission.notebook_display_full_dossier()
        • Submission.notebook_display_solution()
        • Submission.print_solution_status()
        • Submission.project_path
        • Submission.remove_event()
        • Submission.repo_url
        • Submission.run_validation()
        • Submission.run_validation_warnings()
        • Submission.save()
        • Submission.team_name
        • Submission.tier
    • Event Class
      • Event
        • Event._from_dir()
        • Event._save()
        • Event.add_solution()
        • Event.clear_solutions()
        • Event.event_id
        • Event.get_active_solutions()
        • Event.get_solution()
        • Event.model_config
        • Event.remove_all_solutions()
        • Event.remove_solution()
        • Event.run_validation()
        • Event.solutions
        • Event.submission
    • Solution Class
      • Solution
        • Solution._save()
        • Solution.activate()
        • Solution.alias
        • Solution.autofill_hardware_info()
        • Solution.autofill_nexus_info()
        • Solution.bands
        • Solution.compute_info
        • Solution.confidence_level
        • Solution.creation_timestamp
        • Solution.deactivate()
        • Solution.get_notes()
        • Solution.hardware_info
        • Solution.higher_order_effects
        • Solution.is_active
        • Solution.lens_plane_plot_path
        • Solution.lightcurve_plot_path
        • Solution.limb_darkening_coeffs
        • Solution.limb_darkening_model
        • Solution.log_likelihood
        • Solution.model_config
        • Solution.model_type
        • Solution.n_data_points
        • Solution.notes
        • Solution.notes_path
        • Solution.parameter_uncertainties
        • Solution.parameters
        • Solution.physical_parameter_uncertainties
        • Solution.physical_parameters
        • Solution.posterior_path
        • Solution.relative_probability
        • Solution.run_validation()
        • Solution.saved
        • Solution.set_compute_info()
        • Solution.set_notes()
        • Solution.solution_id
        • Solution.t_ref
        • Solution.uncertainty_method
        • Solution.used_astrometry
        • Solution.used_postage_stamps
        • Solution.validate_solution_at_creation()
        • Solution.view_notes()
    • Advanced Usage
    • Best Practices
    • Error Handling
  • Microlensing Submission Format Manual
    • Minimal Workflow: Create → Import → (Optional: Generate Dossier) → Export
    • CSV Import Format
      • Required Columns
      • Model Types (Required in model_tags)
      • Higher-Order Effects (Optional in model_tags)
      • Parameter Columns
        • Core Parameters (Required based on model type)
        • Higher-Order Effect Parameters
        • Flux Parameters (Required if using bands)
      • Optional Columns
        • Example CSV
    • Manual Submission Format
      • Directory Structure
      • File Schemas
        • submission.json
        • event.json
        • solution.json
        • External File Locations
    • Validation
microlens-submit
  • Search


© Copyright 2025, RGES-PIT.

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