New tools documentation #163

GFMoraga · 2023-09-21T16:48:34Z

Change Summary

Made a new tools directory in docs/source/reference/tools . This will have documentation on how to use the tools that are created.

PLEASE give feedback on .rst formatting and what to add/not add.

how do I do the index (tree?) attachment if I need to.

This should check off a "to-do" in #75

New Files

xtce_generator.rst
- documentation on how to use the xtce_generator_template.py to create instrument specific scripts

greglucas

I'm not sure where we want to put this, but if we want to keep it in the API reference section.

imap_processing/docs/source/reference/index.rst

Line 20 in b1a7b65

Adding another heading below instruments would be a good spot for it I think.

I am somewhat hesitant to put it in the API reference though because it isn't a part of the installed package. Maybe we want this to be up in the development section instead and then add it to the toc over there?

greglucas · 2023-09-22T15:23:52Z

docs/source/reference/tools/xtce_generator.rst

+Before you begin, ensure you have the following:
+
+- Python installed (version 3.9 or higher)
+- The required Python packages installed:
+    - pathlib
+    - tools.xtce_generation.telemetry_generator


pathlib is a part of the standard library, and I don't think you need to install telemetry_generator but rather you just use it right?

I'd suggest indicating how you do this with the poetry environments and linking to those documents as well. Something similar to this, feel free to reword as you want.

Generating XTCEs is only done whenever packet definitions get updated, and thus it is not a part of the main processing package. To use it there are a few extra dependencies like pandas that you can install with poetry install --with-extras xtce.

I like this!

docs/source/reference/tools/xtce_generator.rst

maxinelasp

The page looks good overall, I added a few suggestions. Only real changes needed are moving the XML files into another PR, and adding the document to a toctree so it can be discovered.

maxinelasp · 2023-09-22T15:19:43Z

imap_processing/codice/packet_definitions/P_COD_HI_INSTRUMENT_COUNTERS.xml

@@ -3,42 +3,42 @@
 	<xtce:Header date="2023-09" version="1.0" author="IMAP SDC" />


These XML files should be in a different PR, they aren't related to the documentation.

@maxinelasp how do I take these "out" of this commit?

I know that we can do that through git reset soft command but I will let @maxinelasp or @greglucas chime in because I struggle with those kinds of things myself.

I think you're still OK here Gabriel, but it won't be super easy/obvious how to update it either. I think what happened is:

You updated the XML generator

You then ran the generator and updated the codice XML files

You committed both 1 and 2

You got feedback to remove 2 and tried to git rm *.xml in that directory

Now those files are removed and thus have been updated in the opposite direction and still show changes

If that is right, then I think we want to just get back to point 1 above and commit that update?

The way I would approach that is by trying to get back to the original work you had and then modifying that commit. Here is a list of commands that I ran to accomplish this and push to my remote so you can see what it'd look like:
dev...greglucas:imap_processing:gml-xtce-update-docs

Note that during the rebase, I changed the first and third commit to "edit" from "pick" so that I could stop and modify those commits and remove the files from staging. I don't think that stuff is captured here, so these commands won't be verbatim what you need. Also notice the liberal use of git status and git log so I can see where I am in the process and what the current commit has in it.

10088 gh pr checkout 163 10089 git status 10090 git log 10091 git checkout -b gml-xtce-update-docs 10092 git fetch upstream 10093 git rebase -i upstream/dev 10094 git status 10095 git reset --soft HEAD~1 10096 git status 10097 git restore --staged imap_processing/codice/packet_definitions/*.xml 10098 git status 10099 git checkout imap_processing/codice/packet_definitions/*.xml 10100 git status 10101 git log 10102 git commit 10103 git rebase --continue 10104 git status 10105 git restore --staged imap_processing/codice/packet_definitions/*.xml 10106 git status 10107 git commit 10108 git status 10109 git rebase --continue 10110 git status 10111 git push -u origin gml-xtce-update-docs 10112 git log

docs/source/reference/tools/xtce_generator.rst

maxinelasp

Looks a lot better, nice! Just those two code blocks to update from me, and please take the xml files out of the review.

docs/source/development/tools/xtce_generator.rst

GFMoraga

I just deleted the xtce files and will readd in new PR.

tech3371

looks good

GFMoraga · 2023-09-25T22:57:31Z

I need to take a look because I think I messed up my whole setup....ugh

________________________________ From: Tenzin Choedon ***@***.***> Sent: Monday, September 25, 2023 4:38 PM To: IMAP-Science-Operations-Center/imap_processing ***@***.***> Cc: Gabriel Moraga ***@***.***>; Author ***@***.***> Subject: Re: [IMAP-Science-Operations-Center/imap_processing] New tools documentation (PR #163) @tech3371 commented on this pull request.

________________________________ In imap_processing/codice/packet_definitions/P_COD_HI_INSTRUMENT_COUNTERS.xml<#163 (comment)>:

@@ -3,42 +3,42 @@

<xtce:Header date="2023-09" version="1.0" author="IMAP SDC" /> I know that we can do that through git reset soft command but I will let @maxinelasp<https://github.com/maxinelasp> or @greglucas<https://github.com/greglucas> chime in because I struggle with those kinds of things myself. — Reply to this email directly, view it on GitHub<#163 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AY7EAWHQRMCFF76RJH3SGXLX4IBXRANCNFSM6AAAAAA5B3CM3M>. You are receiving this because you authored the thread.Message ID: ***@***.***>

bourque

Nice work @GFMoraga! Looks good!

I fixed all! The right way!

GFMoraga · 2023-09-26T21:47:03Z

@greglucas I rebased! Thank you for the command guidance.

maxinelasp

This looks good to me! Nice job. There is one warning to fix, I put in a comment so you can just click the button to update it.

docs/source/development/tools/xtce_generator.rst

Minor change to reduce warning Co-authored-by: Maxine Hartnett <117409426+maxinelasp@users.noreply.github.com>

greglucas

Nice work! I'm glad you were able to parse the cryptic rebase, it is never easy to recover from things like that.

docs/source/development/tools/index.rst

Co-authored-by: Greg Lucas <greg.m.lucas@gmail.com>

…g into xtce-update-docs

* Made xtce documentation in tools and added files with toctree. Had to rebase.

bourque · 2024-01-31T16:56:58Z

@all-contributors please add @GFMoraga for documentation

allcontributors · 2024-01-31T16:57:07Z

@bourque

I've put up a pull request to add @GFMoraga! 🎉

GFMoraga added Repo: Documentation Improvements or additions to documentation Ins: CoDICE Related to the CoDICE instrument Level: L0 Level 0 processing labels Sep 21, 2023

GFMoraga requested review from bourque, tech3371 and maxinelasp September 21, 2023 16:48

GFMoraga self-assigned this Sep 21, 2023

GFMoraga marked this pull request as ready for review September 22, 2023 15:23

greglucas reviewed Sep 22, 2023

View reviewed changes

maxinelasp requested changes Sep 22, 2023

View reviewed changes

GFMoraga changed the title ~~New tools documentation and updated xtce files~~ New tools documentation Sep 25, 2023

maxinelasp previously requested changes Sep 25, 2023

View reviewed changes

docs/source/development/tools/xtce_generator.rst Show resolved Hide resolved

docs/source/development/tools/xtce_generator.rst Outdated Show resolved Hide resolved

docs/source/development/tools/xtce_generator.rst Outdated Show resolved Hide resolved

GFMoraga commented Sep 25, 2023

View reviewed changes

GFMoraga requested a review from maxinelasp September 25, 2023 21:31

tech3371 approved these changes Sep 25, 2023

View reviewed changes

bourque approved these changes Sep 26, 2023

View reviewed changes

GFMoraga added 2 commits September 26, 2023 15:29

Rebasing try 2

a8a0c55

updated xtce documentation and toctree

8101a0e

maxinelasp approved these changes Sep 26, 2023

View reviewed changes

docs/source/development/tools/xtce_generator.rst Show resolved Hide resolved

Update docs/source/development/tools/xtce_generator.rst

e55fa1f

Minor change to reduce warning Co-authored-by: Maxine Hartnett <117409426+maxinelasp@users.noreply.github.com>

greglucas approved these changes Sep 26, 2023

View reviewed changes

docs/source/development/tools/index.rst Show resolved Hide resolved

GFMoraga and others added 3 commits September 26, 2023 15:55

Update docs/source/development/tools/index.rst

b2665f3

Co-authored-by: Greg Lucas <greg.m.lucas@gmail.com>

used ruff on xtce_generator doc to fix precommit error

504c575

Merge branch 'xtce-update-docs' of github.com:GFMoraga/imap_processin…

4806a19

…g into xtce-update-docs

GFMoraga merged commit 0865c82 into IMAP-Science-Operations-Center:dev Sep 26, 2023
12 checks passed

GFMoraga deleted the xtce-update-docs branch September 26, 2023 22:13

maxinelasp pushed a commit to maxinelasp/imap_processing that referenced this pull request Sep 29, 2023

New tools documentation (IMAP-Science-Operations-Center#163)

d0813b0

* Made xtce documentation in tools and added files with toctree. Had to rebase.

maxinelasp pushed a commit to maxinelasp/imap_processing that referenced this pull request Oct 2, 2023

New tools documentation (IMAP-Science-Operations-Center#163)

8613b55

* Made xtce documentation in tools and added files with toctree. Had to rebase.

laspsandoval pushed a commit to laspsandoval/imap_processing that referenced this pull request Nov 15, 2023

New tools documentation (IMAP-Science-Operations-Center#163)

e3c454e

* Made xtce documentation in tools and added files with toctree. Had to rebase.

allcontributors bot mentioned this pull request Jan 31, 2024

docs: add GFMoraga as a contributor for doc #325

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New tools documentation #163

New tools documentation #163

GFMoraga commented Sep 21, 2023 •

edited

Loading

greglucas left a comment

greglucas Sep 22, 2023

GFMoraga Sep 22, 2023

maxinelasp left a comment

maxinelasp Sep 22, 2023

GFMoraga Sep 25, 2023

tech3371 Sep 25, 2023

greglucas Sep 26, 2023

maxinelasp left a comment

GFMoraga left a comment

tech3371 left a comment

GFMoraga commented Sep 25, 2023 via email

bourque left a comment

GFMoraga commented Sep 26, 2023

maxinelasp left a comment

greglucas left a comment

bourque commented Jan 31, 2024

allcontributors bot commented Jan 31, 2024

New tools documentation #163

New tools documentation #163

Conversation

GFMoraga commented Sep 21, 2023 • edited Loading

Change Summary

PLEASE give feedback on .rst formatting and what to add/not add.

New Files

greglucas left a comment

Choose a reason for hiding this comment

greglucas Sep 22, 2023

Choose a reason for hiding this comment

GFMoraga Sep 22, 2023

Choose a reason for hiding this comment

maxinelasp left a comment

Choose a reason for hiding this comment

maxinelasp Sep 22, 2023

Choose a reason for hiding this comment

GFMoraga Sep 25, 2023

Choose a reason for hiding this comment

tech3371 Sep 25, 2023

Choose a reason for hiding this comment

greglucas Sep 26, 2023

Choose a reason for hiding this comment

maxinelasp left a comment

Choose a reason for hiding this comment

GFMoraga left a comment

Choose a reason for hiding this comment

tech3371 left a comment

Choose a reason for hiding this comment

GFMoraga commented Sep 25, 2023 via email

bourque left a comment

Choose a reason for hiding this comment

GFMoraga commented Sep 26, 2023

maxinelasp left a comment

Choose a reason for hiding this comment

greglucas left a comment

Choose a reason for hiding this comment

bourque commented Jan 31, 2024

allcontributors bot commented Jan 31, 2024

GFMoraga commented Sep 21, 2023 •

edited

Loading