Add link to mast_notebooks repo in README
#79
Conversation
Add link to the jupyter notebook made for astrocut in the `mast_notebooks` repository in the README.rst of the astrocut repo.
| @@ -21,7 +21,7 @@ Three main areas of functionality are included: | |||
| - General fits file cutouts incuding from single images and sets of images with the shared WCS/pixel scale. | |||
| - 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. | |||
There was a problem hiding this comment.
just curious, why doesn't this show up here? https://spacetelescope.github.io/mast_notebooks/
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
A question maybe for @ttdu?
There was a problem hiding this comment.
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.
Add link to the jupyter notebook made for astrocut in the
mast_notebooksrepository in the README.rst of the astrocut repo.