Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc updates #57

Merged
merged 2 commits into from
Jan 3, 2023
Merged

Minor doc updates #57

merged 2 commits into from
Jan 3, 2023

Conversation

jzuhone
Copy link
Member

@jzuhone jzuhone commented Dec 21, 2022

Description

This PR updates the documentation for acis_thermal_check with two changes.

  1. It adds information on how to set up either flight or ACIS Ops ska for how to
  2. It changes the HTML theme to be the default Ska one

Interface impacts

New docs build currently at https://cxc.cfa.harvard.edu/acis/acis_thermal_check.

New setup instructions at https://cxc.cfa.harvard.edu/acis/acis_thermal_check/running_models.html#where-to-run-the-models-from

Testing

None necessary.

@cegrant
Copy link
Contributor

cegrant commented Dec 21, 2022

I figured the best way to review would be for me to try running all the examples on the page, logged in as myself. I don't know ska at all, so if I can use the documentation to run the thermal models, that means the documentation is pretty good. I'm just checking that the examples ran to completion, and that the expected files were produced. I made no attempt to verify the validity of anything.
All the examples ran nominally, except for the last one, "running validation without prediction". I don't know if the problem is the documentation, the script, or me, but I copy/pasted what was in my xterm. Since the primary use for me to run the thermal models is for a standard load review, and those examples worked great, I am happy with the documentation as is. John, let me know if I should ignore the error below and just approval as is or not.

(ska) luke-v-116: dpa_check --run-start=2019:300:12:50:00 --outdir=validate_dec2019
acis_thermal_check: [INFO ] # dpa_check run at Wed Dec 21 15:24:05 2022 by cegrant
acis_thermal_check: [INFO ] # acis_thermal_check version = 4.4.1
acis_thermal_check: [INFO ] # model_spec file MD5sum = a363cf6438302298a1436e551719cabd
acis_thermal_check: [INFO ] Command line options:
{'T_init': None,
'backstop_file': None,
'days': 21.0,
'interrupt': False,
'model_spec': None,
'nlet_file': '/data/acis/LoadReviews/NonLoadTrackedEvents.txt',
'oflsdir': None,
'outdir': PosixPath('validate_dec2019'),
'pred_only': False,
'run_start': '2019:300:12:50:00',
'state_builder': 'acis',
'traceback': True,
'verbose': 1,
'version': False}

acis_thermal_check: [INFO ] ACISThermalCheck is using the 'acis' state builder.
acis_thermal_check: [INFO ] Fetching telemetry between 2019:279:12:50:00.000 and 2019:300:12:50:00.000
acis_thermal_check: [INFO ] Calculating DPA thermal model for validation
Fetching msid: 1dpamzt over 2019:279:12:27:42.816 to 2019:300:13:02:06.816
Fetching msid: dp_dpa_power over 2019:279:12:27:42.816 to 2019:300:13:02:06.816
acis_thermal_check: [INFO ] Making DPA model validation plots and quantile table
acis_thermal_check: [INFO ] Writing quantile table validate_dec2019/validation_quant.csv
acis_thermal_check: [INFO ] Writing validation data validate_dec2019/validation_data.pkl
acis_thermal_check: [INFO ] Checking for validation violations
acis_thermal_check: [WARNING ] 1DPAMZT 1% quantile value of -2.03 exceeds limit of 2.00
acis_thermal_check: [WARNING ] 1DPAMZT 99% quantile value of 2.06 exceeds limit of 2.00
acis_thermal_check: [WARNING ] PITCH 1% quantile value of -3.605 exceeds limit of 3.00
acis_thermal_check: [WARNING ] PITCH 99% quantile value of 4.361 exceeds limit of 3.00
acis_thermal_check: [WARNING ] validation warning(s) in output at validate_dec2019
Traceback (most recent call last):
File "/data/acis/mambaforge/envs/ska/bin/dpa_check", line 8, in
sys.exit(main())
File "/data/acis/mambaforge/envs/ska/lib/python3.8/site-packages/acis_thermal_check/apps/dpa_check.py", line 121, in main
dpa_check.run(args)
File "/data/acis/mambaforge/envs/ska/lib/python3.8/site-packages/acis_thermal_check/main.py", line 233, in run
any_viols = sum(len(viol["values"]) for viol in pred["viols"].values())
AttributeError: 'NoneType' object has no attribute 'values'

Copy link

@jazan12 jazan12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The setups worked for me OK but I hit the same error as Catherine when running. Looks like the plots got generated ok though.

@jzuhone
Copy link
Member Author

jzuhone commented Dec 22, 2022

Thanks @jazan12 and @cegrant--that's a feature basically no one uses and there isn't a test for it, but it should be fixed (and a test added). Not related to the docs PR, I'll open a second one.

Copy link
Contributor

@Gregg140 Gregg140 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Good

@jzuhone jzuhone merged commit cabe70b into acisops:master Jan 3, 2023
@javierggt javierggt mentioned this pull request May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants