Skip to content

Add link to mast_notebooks repo in README#79

Open
jaymedina wants to merge 1 commit into
mainfrom
update-readme
Open

Add link to mast_notebooks repo in README#79
jaymedina wants to merge 1 commit into
mainfrom
update-readme

Conversation

@jaymedina
Copy link
Copy Markdown
Collaborator

Add link to the jupyter notebook made for astrocut in the mast_notebooks repository in the README.rst of the astrocut repo.

Add link to the jupyter notebook made for astrocut in the `mast_notebooks` repository in the README.rst of the astrocut repo.
@jaymedina jaymedina self-assigned this Mar 17, 2023
@jaymedina jaymedina requested a review from hmlewis-astro March 17, 2023 20:33
Comment thread README.rst
- Cutout post-processing functionality, including centering cutouts along a path (for moving targets) and combining cutouts.

Documentation is at https://astrocut.readthedocs.io.
Documentation is at https://astrocut.readthedocs.io. If you'd like to practice working with the tools discussed in this Wiki, we encourage you to work with our [astrocut-for-beginners Jupyter Notebook](https://github.com/spacetelescope/mast_notebooks/tree/main/notebooks/astrocut/making_tess_cubes_and_cutouts), which shows you how to use the tools within make_cube.py and cube_cut.py to generate cutouts from a batch of TESS FFIs retrieved locally via astroquery.mast.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

just curious, why doesn't this show up here? https://spacetelescope.github.io/mast_notebooks/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

oh, it does, here: https://spacetelescope.github.io/mast_notebooks/notebooks/astrocut/making_tess_cubes_and_cutouts/making_tess_cubes_and_cutouts.html

but "astrocut" doesn't render on the sidebar. is it because there's no markdown file in the root of the astrocut/ directory?

guess i'm just wondering if the link should go to this rendered page instead?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the link should point directly to the rendered making_tess_cubes_and_cutouts.html. Users can navigate to the repo using links at the top of the rendered page if they want to download the notebook, see the requirements.txt, etc.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For that website with all the rendered notebooks, there's no sidebar nav for astrocut. So people can't discover this page on their own. Is that intentional?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A question maybe for @ttdu?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I will fix this. RIght now, the sidebar does not automatically update based on the repository content, so I will manually add the astrocut notebook.

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.

4 participants