Skip to content

New ROSAT All-Sky Survey 'getting started' notebook#236

Open
DavidT3 wants to merge 84 commits intomainfrom
notebook/newRASSGettingStarted
Open

New ROSAT All-Sky Survey 'getting started' notebook#236
DavidT3 wants to merge 84 commits intomainfrom
notebook/newRASSGettingStarted

Conversation

@DavidT3
Copy link
Collaborator

@DavidT3 DavidT3 commented Feb 18, 2026

Meant as a test of building this notebook on CircleCI, have been having some problems with it unfortunately.

Not least of which was that when I tried to use a larger resource than I was allowed on CircleCI, it doesn't seem to return a failure code to the check running on the PR, so it just keeps waiting forever.

I closed the original test PR and opened this one to hopefully get out of that problem.

Science review checklist

  • Does using high-energy data make up a significant part of the tutorial?
  • Is there a use case in the introduction that motivates the code?
  • Does the code do what the introduction says it is going to do?
  • Is it scientifically accurate?
  • Have all necessary references to literature been included?

Formatting checklist

  • Did you base your notebook on the HEASARC-tutorials template?
  • Are all sections in the HEASARC-tutorial template included in your notebook?
  • Is the notebook title compact and informative? It will be the name of the notebook on the HEASARC website!
  • Have you populated the notebook front-matter (the metadata at the top of the notebook)?
  • Is the kernel specified in the front-matter (e.g., heasoft, sas, ciao) correct for the notebook?
  • Have you added an entry for your notebook in the *_index.md file for the containing directory?
  • Is all plotting matplotlib (or alternative) plotting code in isolated cells, and do they have the metadata required to collapse the code when the notebook/website is viewed?

Tech review checklist

  • Documentation:
    • Is every function documented?
    • Do all code cells have corresponding narratives/comments?
    • Are all code comments of a purely technical nature? All narratives should be in Markdown cells.
    • Did you populate the 'Runtime' section?
  • Notebook execution, error handling, etc.:
    • Does the notebook run end-to-end, out of the box?
    • Are errors handled appropriately, with try/except statements that are narrow in scope?
    • Have warnings been dealt with appropriately, preferably by updating the code to avoid them (i.e., not by simply silencing them)?
  • Efficiency:
    • Is data accessed from the cloud where possible?
    • Is the code parallelized where possible?
    • If the notebook is intended to be scaled up, does it do that efficiently?
    • Is memory usage optimized where possible?
  • Cleanup:
    • Have blocks of code that need to be re-used been turned into functions and placed in the 'global setup'-'function' section?
    • Has unused code been removed (e.g., unused functions and commented-out lines)?
    • Are comment lines wrapped so all fit within a max of 90 - 100 characters per line?
    • Do plots use color-blind friendly palettes for plotting? Try this simulator for a visual check.

David Turner added 30 commits February 12, 2026 10:24
…a skeleton at the moment, many imports commented out. For issue #228
…y-survey.md notebook. It fetches the CARMENES M dwarf catalog, uploads the table and matches with 2RXS. For issue #228
…survey.md notebook to make sure that the table upload to the TAP service works. For issue #228
…ding to HEASARC TAP, removing the string sexagesimal coordinates which were causing type issues.
…l-sky-survey.md notebook, concerned with matching the catalogs and downloading the RASS data. For issue #228
…ng if we actually _need_ to download any of it? - could we stream it?) For issue #228
…in the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…-started-rosat-all-sky-survey.md tutorial. For issue #228
…on files into the getting-started-rosat-all-sky-survey.md tutorial. Adjusted everything so that there are two different 'OUT_DIR's'; one for general sequence products and one for source-specific products. For issue #228
…ated in the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…osat-all-sky-survey.md tutorial notebook. For issue #228
… name so that it could be included in the output file paths, in the getting-started-rosat-all-sky-survey.md. For issue #228
…orrect RMF and stores it in the ROOT_DATA_DIR. Also puts that path in a variable for later use. Also should have ARF generation and possibly spectrum grouping working. For issue #228
…ool in the getting-started-rosat-all-sky-survey.md notebook. Was getting some problems with file name length I think. For issue #228
…the newly generated spectrum files in getting-started-rosat-all-sky-survey.md. For issue #228
…backfile, ancrfile, and respfile are written to spectrum headers AFTER grouping (otherwise you get the XSPEC issue with '&' at the end when using long file names like I do. Also started adding model fitting code. For issue #228
…y.md section. It no longer loads all spectra in at once, which does make it a little less elegant, but ultimately easier to handle those spectra without enough noticed channels. For issue #228
…uring the spectral fitting process. Unfortunately, there are XSPEC warnings appearing about no variable parameters which rather ruins the look of it all. In getting-started-rosat-all-sky-survey.md, for issue #228
…y.md, also added a section to save RASS results as a CSV. For issue #228 (code might now all be in, just have to write narrative).
…-survey.md to show the results we measured. This could well round off the code contents of this demonstration. For issue #228
…-started-rosat-all-sky-survey.md, they got lost in the copying of code from prototype notebook back into the real one. For issue #228
…ean column in the RASS results to indicate if there was a problem with the error calculation of any parameters. In the getting-started-rosat-all-sky-survey.md notebook. For issue #228
David Turner added 16 commits February 19, 2026 16:29
…ROSAT can still be useful to the beginning of section 4 in getting-started-rosat-all-sky-survey.md. For issue #228
…he getting-started-rosat-all-sky-survey.md tutorial. For issue #228
…the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…ng supporting files bit of getting-started-rosat-all-sky-survey.md. For issue #228
…trum files in the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…most important steps in getting-started-rosat-all-sky-survey.md. For issue #228
…n in the XSPEC fitting section of the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…-sky-survey.md notebook. Also fixed the figure demonstrating new images we made much earlier in the notebook. For issue #228
…PEC fits in the getting-started-rosat-all-sky-survey.md notebook. For issue #228
…ey.md! Other than the introduction, which I will finish now. For issue #228
….md notebook, which means the first pass is done and it is ready for review! For issue #228
@DavidT3 DavidT3 added skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. and removed skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. labels Feb 20, 2026
@DavidT3 DavidT3 marked this pull request as ready for review February 20, 2026 21:09
@DavidT3 DavidT3 removed the skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. label Feb 20, 2026
…ow make some tiny changes to some code cells to trigger the test build. For issue #228 and PR #236
@DavidT3 DavidT3 added the ready-for-review HEASARC internal review process can begin label Feb 20, 2026
David Turner added 7 commits February 20, 2026 17:22
…ey.md notebook - all were pointing to specific sections of the notebook whose name had changed. For PR #236
…o that the column names might make more sense to a general reader in the returned matched table. Fixed some typos as well.
…hat will hopefully collapse the output so we don't have to look at all those 'no variable parameters for fit' irrepressible warnings.
@DavidT3 DavidT3 linked an issue Feb 23, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-content Changes or additions to the content of the documentation enhancement New feature or request mission-specific Issues that relate to a single high-energy mission ready-for-review HEASARC internal review process can begin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ROSAT All-Sky M Dwarf 'getting started' tutorial

1 participant