Usage

Command-Line Interface

Run the pipeline via the command-line:

ulens-lsst --config config.yaml --steps all

Available steps: all, simulate, load_nearby, process_photometry, chi2. Example for specific steps:

ulens-lsst --config config.yaml --steps simulate,process_photometry

Outputs are saved in a directory named after name under main_path (e.g., /runs/my_simulation/) as specified in config.yaml. See Data Setup and Outputs for details.

Programmatic Usage

For programmatic use:

from ulens_lsst.simulation_pipeline import SimPipeline
sim = SimPipeline('config.yaml')
results = sim.simulate_lightcurves(event_processor='ulens')
print(results)

Output Files: Simulation outputs (temporary files and results) are saved in a directory named after name under main_path as specified in config.yaml (e.g., /runs/my_simulation/). See Data Setup and Outputs for details.

See the API Reference section for detailed class and method documentation.

(Soon) See the Tutorials section for interactive examples and the API Reference section for detailed class and method documentation.