update readme

# pg3_calibration

Calibration for POWGEN

===

This is the repo for hosting all the POWGEN calibration relevant scripts and configurations.

This is the repo for hosting all the POWGEN calibration relevant scripts,

configurations, and results.

How-To

===

1. Configure

    To run the calibration routine locally, one first needs to fill in necessary

    configurations in the `/SNS/PG3/shared/CALIBRATION/cal_config.json` file.

2. Run

    Open a terminal and change directory to `/SNS/PG3/shared/CALIBRATION`, and then

    execute `mantidpython pg3_cal_local.py`.

3. Outcome

    The generated calibration file will be saved into two locations. One in the

    specified cycle directory as in the configuration file. The other save spot is

    `/SNS/PG3/shared/CALIBRATION/autoreduce` and will be used for the purpose of

    autoreduction. Meanwhile, diagnostics plots will be generated and saved into

    locations parallel to each of the two saved calibration files.

---

Yuanpeng Zhang @ 2023-10-19 Thu 12:06 PM EDT

SNS-HFIR, ORNL

---