# nenucal

`nenucal` is a calibration and data-management toolkit for
[NenuFAR](https://nenufar.obs-nancay.fr) radio observations. It was developed
for the Cosmic Dawn project but is not specific to it — it can be used for any
NenuFAR imaging observation.

At its core it provides three things:

- a **data management tool** ([nenudata](nenudata/index)) to organise observations,
  spectral windows, and node layout across the cluster, and to move data between
  processing stages;
- a **calibration pipeline** ([calpipe](calpipe/index)), running on top of
  [DP3](https://dp3.readthedocs.io) and driven by TOML configuration files;
- a set of **utilities** to handle the supporting data products — gain solution
  tables ([soltool](soltool/index)), sky models ([modeltool](modeltool/index)),
  flagging ([flagtool](flagtool/index)), MeasurementSets ([mstool](mstool/index)),
  and imaging ([imgpipe](imgpipe/index)).

`nenucal` is designed to be composed into full end-to-end pipelines rather than
run on its own. For the Cosmic Dawn project it is used in two such
pipelines, both general enough to be reused by any NenuFAR project:

- [**nenuprepipe**](https://gitlab.com/nenufar-cosmic-dawn/nenuprepipe) —
  pre-processing of raw NenuFAR data (L1) into quality-checked MeasurementSets ready
  for calibration (L2);
- [**nenuflow**](https://gitlab.com/nenufar-cosmic-dawn/nenuflow) — the
  direction-dependent calibration pipeline.


```{toctree}
:maxdepth: 2
:caption: Contents

Installation <installation>
Calibration pipeline <calpipe/index>
Sky model tools <modeltool/index>
MeasurementSet utilities <mstool/index>
Data management <nenudata/index>
Gain solution tools <soltool/index>
Flagging tools <flagtool/index>
Imaging <imgpipe/index>
Changelog <changelog>
```