Upload README.md

README.md

@@ -2,9 +2,135 @@
 license: cc0-1.0
 configs:
   - config_name: observations
-    data_files: "*_obs.parquet"
+    data_files: '*_obs.parquet'
   - config_name: metadata
-    data_files: "*_meta.parquet"
+    data_files: '*_meta.parquet'
   - config_name: epochs
-    data_files: "*_epoch.parquet"
----
+    data_files: '*_epoch.parquet'
+---
+
+# Machine Learning Tier
+
+The machine learning tier data is provided as a set of normalized tables in Parquet format: **RMDC26_ML_Data_obs.parquet**, **RMDC26_ML_Data_meta.parquet**, and **RMDC26_ML_Data_epoch.parquet**.
+
+## Tables
+
+### 1. Observations Table (`_obs.parquet`)
+Contains the primary time-series data for all events.
+
+| Column Name | Data Type | Description |
+| :--- | :--- | :--- |
+| `event_id` | int64 | Unique event identifier. |
+| `epoch_id` | int64 | Identifier for the specific observation epoch. |
+| `filt` | string | Filter used for the observation. Values: `F087`, `F146`, `F213`. |
+| `flux_uJy` | float64 | Measured flux in microjanskys (μJy). |
+| `flux_err_uJy` | float64 | Uncertainty in the measured flux in μJy. |
+| `saturation_flag` | float64 | Saturation flag: 0 = unsaturated, 1 = saturated. |
+
+### 2. Metadata Table (`_meta.parquet`)
+Contains the "ground truth" and physical parameters for each event.
+
+| Column Name | Data Type | Description |
+| :--- | :--- | :--- |
+| `name` | string | Unique event identifier (e.g., `RMDC26_XXXXXX`). |
+| `event_id` | int64 | Integer ID matching the observations table. |
+| `sim_label` | string | Simulation category (e.g., `RMDC26_SINGLE`). |
+| `SubRun` | float64 | Sub-run identifier. |
+| `Field` | float64 | Field identifier. |
+| `EventID` | float64 | Event ID. |
+| `final_weight` | float64 | Population weight for the event. |
+| `ObsGroup_0_chi2` | float64 | Fit quality indicator ($\chi^2$). |
+| `t0lens1` | float64 | Time of closest approach for the primary lens. |
+| `tE_ref` | float64 | Einstein timescale (reference frame). |
+| `tE_helio` | float64 | Einstein timescale (heliocentric frame). |
+| `u0lens1` | float64 | Impact parameter. |
+| `rho` | float64 | Normalized source radius. |
+| `piE` | float64 | Microlens parallax. |
+| `piEE` | float64 | Parallax-parallax term. |
+| `piEN` | float64 | Parallax-North term. |
+| `piEll` | float64 | Parallax-ellipticity term. |
+| `piErp` | float64 | Parallax-rotation term. |
+| `rE` | float64 | Einstein radius. |
+| `thetaE` | float64 | Einstein angular radius. |
+| `ra_deg` | float64 | Event right ascension in degrees. |
+| `dec_deg` | float64 | Event declination in degrees. |
+| `galactic_l` | float64 | Galactic longitude. |
+| `galactic_b` | float64 | Galactic latitude. |
+| `fs_F146` | float64 | Source flux fraction in F146. |
+| `fs_F087` | float64 | Source flux fraction in F087. |
+| `fs_F213` | float64 | Source flux fraction in F213. |
+| `fs2_F146` | float64 | Second source flux fraction in F146. |
+| `fs2_F087` | float64 | Second source flux fraction in F087. |
+| `fs2_F213` | float64 | Second source flux fraction in F213. |
+| `Lens_F146` | float64 | Lens magnitude in F146. |
+| `Lens_F087` | float64 | Lens magnitude in F087. |
+| `Lens_F213` | float64 | Lens magnitude in F213. |
+| `Source_F146` | float64 | Source magnitude in F146. |
+| `Source_F087` | float64 | Source magnitude in F087. |
+| `Source_F213` | float64 | Source magnitude in F213. |
+| `Source2_F146` | float64 | Second source magnitude in F146. |
+| `Source2_F087` | float64 | Second source magnitude in F087. |
+| `Source2_F213` | float64 | Second source magnitude in F213. |
+| `Source_Is_Binary` | float64 | Flag indicating if the source is binary. |
+| `Source_q` | float64 | Mass ratio of the binary source. |
+| `Source_combined_logP` | float64 | Combined log period of binary source. |
+| `Source_total_mass` | float64 | Total mass of binary source. |
+| `Source2_rho` | float64 | Normalized radius of second source. |
+| `Source2_s` | float64 | Projected separation of second source. |
+| `Source2_alpha` | float64 | Angle of second source. |
+| `Source2_inc` | float64 | Inclination of second source. |
+| `Source2_phase` | float64 | Phase of second source. |
+| `Planet_mass` | float64 | Mass of the planet (if present). |
+| `Planet_q` | float64 | Planet-to-star mass ratio. |
+| `Planet_s` | float64 | Projected separation of the planet. |
+| `Planet_period` | float64 | Orbital period of the planet. |
+| `Planet_semimajoraxis` | float64 | Semimajor axis of the planet. |
+| `Planet_orbphase` | float64 | Orbital phase of the planet. |
+| `Planet_inclination` | float64 | Inclination of the planet. |
+| `Lens_Mass` | float64 | Mass of the lens. |
+| `Lens_Dist` | float64 | Distance to the lens. |
+| `Lens_Teff` | float64 | Effective temperature of the lens. |
+| `Lens_logg` | float64 | Surface gravity of the lens. |
+| `Lens_Fe_H` | float64 | Metallicity of the lens. |
+| `Source_Mass` | float64 | Mass of the source. |
+| `Source_Dist` | float64 | Distance to the source. |
+| `Source_Teff` | float64 | Effective temperature of the source. |
+| `Source_logg` | float64 | Surface gravity of the source. |
+| `Source_Fe_H` | float64 | Metallicity of the source. |
+| `Source2_Mass` | float64 | Mass of the second source. |
+| `Source2_Dist` | float64 | Distance to the second source. |
+| `Source2_Teff` | float64 | Effective temperature of the second source. |
+| `Source2_logg` | float64 | Surface gravity of the second source. |
+| `Source2_Fe_H` | float64 | Metallicity of the second source. |
+| `extinction_F146` | float64 | Extinction in F146. |
+| `extinction_F087` | float64 | Extinction in F087. |
+| `extinction_F213` | float64 | Extinction in F213. |
+
+### 3. Epochs Table (`_epoch.parquet`)
+Contains unique spatio-temporal definitions for every observation epoch.
+
+| Column Name | Data Type | Description |
+| :--- | :--- | :--- |
+| `epoch_id` | int64 | Unique identifier for the epoch. |
+| `bjd` | float64 | Barycentric Julian Date. |
+| `obs_x` | float64 | Observatory X-coordinate in AU. |
+| `obs_y` | float64 | Observatory Y-coordinate in AU. |
+| `obs_z` | float64 | Observatory Z-coordinate in AU. |
+
+## Simulation Details & Disclaimer
+
+**Simulation Engine:** All events have been generated using **GULLS**. More information is available at [gulls-microlensing.github.io](https://gulls-microlensing.github.io/).
+
+**Event Complexity:**
+- There are three simulations included in this dataset:
+    - `RMDC26_SINGLE`: Single lens and single source events.
+    - `RMDC26_CPSQ610100`: One star - one planet lens and single source events.
+    - `RMDC26_CPSQ600100`: One star - one planet lens and binary source events.
+- Note that not all lens and sources are neccesarily involved in the microlensing event. `ObsGroup_0_chi2` > 160 indicates that an anomaly may be present in the light curve. 
+
+**Dataset Structure:**
+- The dataset is split into **observations**, **metadata**, and **epochs**.
+- To reconstruct a full lightcurve for an event, join the `obs` table with the `meta` table on `event_id` and the `epoch` table on `epoch_id`.
+
+**Disclaimer:** This dataset is intended for testing and development purposes and should be used with the understanding of the biases inherent in the simulation sampling.
+