updates to IMAP-Hi and SWE's document #283
Conversation
tech3371
added
Repo: Documentation
tech3371
requested review from
bourque,
sdhoyt,
greglucas,
bryan-harter,
laspsandoval,
GFMoraga and
maxinelasp
and removed request for
a team
docs/source/reference/hi.rst
Outdated
|
|
||
| decom | ||
|
|
||
| IMAP-Hi test and validation code can be found below. |
There was a problem hiding this comment.
I personally wouldn't worry about documenting the test and validation code, probably especially with the autosummary just because we don't generally put great docstrings into the tests. Maybe just a link to specific test or validation methods that would be useful to point others to (if any)?
There was a problem hiding this comment.
I didn't have anything to add for Hi at this moment besides those two. I could remove those and then we can add L1A as we develop.
There was a problem hiding this comment.
I'd suggest removing them for now then. I actually think a description of the instrument and what it does is just fine for this start of documentation without any need to reference code here if there is nothing to reference. Just making the placeholder is a win :)
docs/source/reference/hi.rst
Outdated
|
|
||
| The L0 code to decommutate the CCSDS packet data can be found below. | ||
|
|
||
| .. currentmodule:: imap_processing |
There was a problem hiding this comment.
This should be documented in the root level imap_processing location, not within hi.
docs/source/reference/swe.rst
Outdated
| l1a.swe_l1a | ||
| l1a.swe_science | ||
|
|
||
| The L1A code to process electron counts to rates and then |
There was a problem hiding this comment.
| The L1A code to process electron counts to rates and then | |
| The L1B code to process electron counts to rates and then |
Out of curiosity are we capitalizing both "L" and "B" here, or are we calling them "L1b" or "l1b"?
There was a problem hiding this comment.
good catch! If I start L with then it made sense to end with capital letter as well. Otherwise, not particular about it.
There was a problem hiding this comment.
I'm not particular about which version to choose, my only preference is for consistency if we can meet that. I think filenames will be lowercase l1b, but maybe if we are writing in sentences we will write L1B with all caps like you have?
docs/source/reference/swe.rst
Outdated
| l1a.swe_l1a | ||
| l1a.swe_science | ||
|
|
||
| The L1A code to process electron counts to rates and then |
There was a problem hiding this comment.
I like that you broke these up with a description of what they do too!
| @@ -139,28 +139,28 @@ def calculate_calibration_factor(time): | |||
| 3. Linear interpolate between those two nearest time and get factor for input time. | |||
|
|
|||
| What this function is doing: | |||
There was a problem hiding this comment.
Might need an extra linebreak here so the 1. isn't wrapped into this statement.
Also, the list above this might need to have the pipes too?
https://imap-processing--283.org.readthedocs.build/en/283/reference/generated/imap_processing.swe.l1b.swe_l1b_science.calculate_calibration_factor.html#imap_processing.swe.l1b.swe_l1b_science.calculate_calibration_factor
|
@all-contributors please add @tech3371 for documentation. |
|
I've put up a pull request to add @tech3371! 🎉 |
…#283) * Added IMAP-Hi to the document and updated SWE's document
Change Summary
Before I forget, small PR for updates in document to include hi and minor updates to SWE.
New Files
Updated Files