Still to come...

[KriSun95]

Coming from PR #1...

@thanasipantazides @mstores98

>3,200 lines of code but a lot of it's documentation. I'm merging now before it gets any longer and I think now is a good point to merge.

Example now exist on how to use the code.

Things still to do:

• create a guide document
  • Now exists (see Pr added first version of the data guide #10)
• Create online documentation
  • this should be the best form of documentation since it will be set up to update with the code as work happens and doesn't require tracking multiple documents across different platforms.
  • see PR Add docs #11 to added numpy doc support to see if that helps #15 for the first version that was set up
  • the docs can be found at https://foxsi.github.io/response-tools/index.html
• add in download functionality
  • see Pr Add YAML-dependent downloader #4,WIP: Incorporate Downloader and CMOS Products #5, and CdTe detector response can now be downloaded #6
• change the repo to a Python only repo.
  • this moves all the code up a directory level but obviously makes the code far easier to maintain
  • see PR WIP: More Building #3
• add higher level support for the CMOS telescopes
• use the codebase to create XSPEC compatible files

[KriSun95]

Our documentation is now live and working.

Still needs some work, formatting, etc. but I think it's a good start.

The online code documentation can be found here: https://foxsi.github.io/response-tools/index.html

[KriSun95]

For the Online Documentation:

• @thanasipantazides : working on the instrumentation documentation
• @yixianz : working on the observation documentation

Markdown files are in the docs folder.

Add any png figures you want referenced/linked in the documentation the assets folder (https://github.com/foxsi/response-tools/tree/main/response_tools/assets)

If you want to build the entire docs locally and are having issues, @KriSun95 can help there but just viewing the markdown file being edited in a local preview app should show the docs will work and build properly.

• Build-the-docs commands come from the Github Workflows YAML file

[KriSun95]

@NShunsaku , would you be interested in taking on the "use the codebase to create XSPEC compatible files" bullet point above?

I'm thinking it would be great to use this package to extract the response information we want then write some functions that could take the response info and convert/save it into the FITS files we need for, say, XSPEC. It would be great to have a discussion on this.

[NShunsaku]

@KriSun95
Of course I can do this, But it is good to discuss the strategy and timeline.
Let's discuss on Oct 20th