Add/Update README and hero figure
Browse filesThis PR adds an automatically generated README.md and a sample visualization (hero figure).
cc @mperillo @tbussozungri
- README.md +123 -3
- example_figure.png +3 -0
README.md
CHANGED
|
@@ -1,3 +1,123 @@
|
|
| 1 |
-
---
|
| 2 |
-
|
| 3 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
configs:
|
| 3 |
+
- config_name: default
|
| 4 |
+
data_dir: mmu_foundation/dataset
|
| 5 |
+
tags:
|
| 6 |
+
- astronomy
|
| 7 |
+
license: cc-by-4.0
|
| 8 |
+
pretty_name: mmu_foundation
|
| 9 |
+
size_categories:
|
| 10 |
+
- n<1K
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
<div align="center">
|
| 14 |
+
<img src="example_figure.png" width="600">
|
| 15 |
+
</div>
|
| 16 |
+
|
| 17 |
+
# mmu_foundation HATS Catalog Collection
|
| 18 |
+
|
| 19 |
+
This is the collection of HATS catalogs representing mmu_foundation.
|
| 20 |
+
|
| 21 |
+
This dataset is part of the [Multimodal Universe](https://github.com/MultimodalUniverse/MultimodalUniverse),
|
| 22 |
+
a large-scale collection of multimodal astronomical data. For full details, see the paper:
|
| 23 |
+
[The Multimodal Universe: Enabling Large-Scale Machine Learning with 100TBs of Astronomical Scientific Data](https://arxiv.org/abs/2412.02527).
|
| 24 |
+
|
| 25 |
+
### Access the catalog
|
| 26 |
+
|
| 27 |
+
We recommend the use of the [LSDB](https://lsdb.io) Python framework to access HATS catalogs.
|
| 28 |
+
LSDB can be installed via `pip install lsdb` or `conda install conda-forge::lsdb`,
|
| 29 |
+
see more details [in the docs](https://docs.lsdb.io/).
|
| 30 |
+
The following code provides a minimal example of opening this catalog:
|
| 31 |
+
|
| 32 |
+
```python
|
| 33 |
+
import lsdb
|
| 34 |
+
|
| 35 |
+
# Full sky coverage.
|
| 36 |
+
catalog = lsdb.open_catalog("https://huggingface.co/datasets/UniverseTBD/mmu_foundation")
|
| 37 |
+
# One-degree cone.
|
| 38 |
+
catalog = lsdb.open_catalog(
|
| 39 |
+
"https://huggingface.co/datasets/UniverseTBD/mmu_foundation",
|
| 40 |
+
search_filter=lsdb.ConeSearch(ra=126.0, dec=25.0, radius_arcsec=3600.0),
|
| 41 |
+
)
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
Each catalog in this collection is represented as a separate [Apache Parquet dataset](https://arrow.apache.org/docs/python/dataset.html) and can be accessed with a variety of tools, including `pandas`, `pyarrow`, `dask`, `Spark`, `DuckDB`.
|
| 45 |
+
|
| 46 |
+
### File structure
|
| 47 |
+
|
| 48 |
+
This catalog is represented by the following files and directories:
|
| 49 |
+
|
| 50 |
+
- [`collection.properties`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/collection.properties) � textual metadata file describing the HATS collection of catalogs
|
| 51 |
+
- [`mmu_foundation`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation) � main HATS catalog directory
|
| 52 |
+
- [`dataset/`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation/dataset/) � Apache Parquet dataset directory for the main catalog
|
| 53 |
+
- ... parquet metadata and data files in sub directories ...
|
| 54 |
+
- [`hats.properties`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation/hats.properties) � textual metadata file describing the main HATS catalog
|
| 55 |
+
- [`partition_info.csv`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation/partition_info.csv) � CSV file with a list of catalog HEALPix tiles (catalog partitions)
|
| 56 |
+
- [`skymap.fits`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation/skymap.fits) � HEALPix skymap FITS file with row-counts per HEALPix tile of fixed order 10
|
| 57 |
+
- [`mmu_foundation_10arcs/`](https://huggingface.co/datasets/UniverseTBD/mmu_foundation/mmu_foundation_10arcs) � default margin catalog to ensure data completeness in cross-matching, the margin threshold is 10.0 arcseconds
|
| 58 |
+
- ... margin catalog files and directories ...
|
| 59 |
+
|
| 60 |
+
### Catalog metadata
|
| 61 |
+
|
| 62 |
+
Metadata of the main HATS catalog, excluding margins and indexes:
|
| 63 |
+
|
| 64 |
+
| **Number of rows** | **Number of columns** | **Number of partitions** | **Size on disk** | **HATS Builder** |
|
| 65 |
+
| --- | --- | --- | --- | --- |
|
| 66 |
+
| 360 | 7 | 171 | 193.0 MiB | hats-import v0.7.3, hats v0.7.3 |
|
| 67 |
+
|
| 68 |
+
|
| 69 |
+
### Catalog columns
|
| 70 |
+
|
| 71 |
+
The main HATS catalog contains the following columns:
|
| 72 |
+
|
| 73 |
+
| **Name** | **`_healpix_29`** | **`lightcurve.band`** | **`lightcurve.time`** | **`lightcurve.flux`** | **`lightcurve.flux_err`** | **`redshift`** | **`host_log_mass`** | **`ra`** | **`dec`** | **`obj_type`** | **`object_id`** |
|
| 74 |
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
| 75 |
+
| **Data Type** | int64 | list[string] | list[float] | list[float] | list[float] | float | float | double | double | string | string |
|
| 76 |
+
| **Nested?** | � | lightcurve | lightcurve | lightcurve | lightcurve | � | � | � | � | � | � |
|
| 77 |
+
| **Value count** | 360 | 17,008 | 17,008 | 17,008 | 17,008 | 360 | 360 | 360 | 360 | 360 | 360 |
|
| 78 |
+
| **Example row** | 339588456743818884 | [g, g, g, g, g, g, g, g, g, g, g, g, � (56 total)] | [5.778e+04, 5.779e+04, 5.78e+04, � (56 total)] | [1219, 682.2, 547.6, 129.3, 88.42, � (56 total)] | [95.98, 95.54, 193, 90.31, 76.68, 0, � (56 total)] | 0.09284 | 9.137 | 126.1 | 25 | Ia | iPTF17dz |
|
| 79 |
+
| **Minimum value** | 3547481393604017 | g | -99.0 | -2181.111083984375 | -0.0 | 0.004886799957603216 | 6.0 | 1.4732304811477661 | -28.45744514465332 | Ia | 2016W |
|
| 80 |
+
| **Maximum value** | 3424691708467754140 | z | 57970.5625 | 544487.625 | 7568.98779296875 | 0.10942360013723373 | 11.739999771118164 | 358.35638427734375 | 84.6783218383789 | Ia | iPTF17dz |
|
| 81 |
+
|
| 82 |
+
|
| 83 |
+
"Nested" indicates whether the column is stored as a nested field inside another "struct" column.
|
| 84 |
+
|
| 85 |
+
|
| 86 |
+
"Value count" may be different from the total number of rows for nested columns: each nested element is counted as a single value.
|
| 87 |
+
|
| 88 |
+
|
| 89 |
+
|
| 90 |
+
|
| 91 |
+
### Crossmatch with another catalog
|
| 92 |
+
|
| 93 |
+
HATS catalogs can be efficiently crossmatched using [LSDB](https://lsdb.io),
|
| 94 |
+
which leverages the HEALPix partitioning to avoid loading the full datasets into memory:
|
| 95 |
+
|
| 96 |
+
```python
|
| 97 |
+
import lsdb
|
| 98 |
+
|
| 99 |
+
mmu_foundation = lsdb.open_catalog("https://huggingface.co/datasets/UniverseTBD/mmu_foundation")
|
| 100 |
+
other = lsdb.open_catalog("https://huggingface.co/datasets/<org>/<other_catalog>")
|
| 101 |
+
|
| 102 |
+
crossmatched = mmu_foundation.crossmatch(other, radius_arcsec=1.0)
|
| 103 |
+
print(crossmatched)
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
See the [LSDB documentation](https://docs.lsdb.io/) for more details on crossmatching and other operations.
|
| 107 |
+
|
| 108 |
+
### Dataset-specific context
|
| 109 |
+
|
| 110 |
+
**Original survey**
|
| 111 |
+
This dataset is based on the Foundation Data Release 3 (Foundation DR3) and contains a collection of 180 spectroscopically confirmed Type Ia supernova light curves.
|
| 112 |
+
|
| 113 |
+
**Data modality**
|
| 114 |
+
The dataset consists of light curve data including time of observation, flux, flux error, and band pass filter information (griz bands). Additional metadata includes supernova classification, coordinates, redshift, and host galaxy mass.
|
| 115 |
+
|
| 116 |
+
**Typical use cases**
|
| 117 |
+
The dataset can be used for photometric redshift prediction and light curve inpainting.
|
| 118 |
+
|
| 119 |
+
**Caveats**
|
| 120 |
+
The data is collected from the Pantheon+ compilation, which applies a series of selection cuts that define the final sample.
|
| 121 |
+
|
| 122 |
+
**Citation**
|
| 123 |
+
Users should cite the original Foundation DR3 data and the Pantheon+ compilation. The data is accessed through the [compilation’s GitHub](https://github.com/PantheonPlusSH0ES/DataRelease/tree/main/Pantheon%2B_Data/1_DATA/photometry/Foundation_DJ17)
|
example_figure.png
ADDED
|
Git LFS Details
|