diff --git a/.github/ISSUE_TEMPLATE/new-tutorial.yml b/.github/ISSUE_TEMPLATE/new-tutorial.yml deleted file mode 100644 index fa037d918..000000000 --- a/.github/ISSUE_TEMPLATE/new-tutorial.yml +++ /dev/null @@ -1,82 +0,0 @@ -name: Tutorial submission -description: Submit a tutorial or set of tutorials to Astropy Learn. -title: "[New tutorial]: " -labels: ["content-new", "needs-content-review"] -body: - - type: markdown - attributes: - value: | - Please complete all of the below information to submit a tutorial or set of tutorials. Thanks in advance for your contribution to Astropy Learn! - - type: input - id: tutorial-title - attributes: - label: Tutorial title - validations: - required: true - - type: textarea - id: authors - attributes: - label: Tutorial authors - description: Include author names, GitHub usernames and ORCID IDs - validations: - required: true - - type: textarea - id: requirements - attributes: - label: Notebook requirements - description: Python packages required to run the notebook(s) - validations: - required: true - - type: textarea - id: description - attributes: - label: Description - description: Provide a summary of the tutorial. - validations: - required: true - - type: textarea - id: ancillary-files - attributes: - label: Attach files - description: Attach the tutorial notebook(s) and any necessary ancillary files (e.g., data files) needed to run them. Note anything about the files that is not clear from the filenames here. - validations: - required: true - - type: textarea - id: index-content - attributes: - label: Book summary (if multiple notebooks) - description: If you are submitting a set of thematically linked tutorials (called a 'book'), please provide a paragraph summarizing all of the notebooks, making clear their sequential order. - validations: - required: false - - type: checkboxes - id: check-citation - attributes: - label: Citation - description: Check here if you would like the tutorial to be made citable via an upload to [Zenodo](https://zenodo.org/). (If so, be sure to include the authors' ORCID IDs above.) - options: - - label: Yes, I would like the tutorial to be made citable via Zenodo. - required: false - - type: checkboxes - id: check-intro - attributes: - label: Introduction format - description: The tutorial(s) contain a complete Introduction cell that includes the tutorial title, author list, learning goals, keywords, companion content if relevant, and a summary - following the format in the [contributing guidelines](https://learn.astropy.org/contributing/). - options: - - label: I confirm. - required: true - - type: checkboxes - id: check-guidelines - attributes: - label: Contribution guidelines - description: I am familiar with the Learn Astropy [contributing guidelines](https://learn.astropy.org/contributing/). - options: - - label: I confirm. - required: true - - type: checkboxes - id: check-coc - attributes: - label: Code of Conduct - description: I am familiar with the Astropy community [code of conduct](https://github.com/astropy/astropy/blob/main/CODE_OF_CONDUCT.md) and agree to follow it. - options: - - label: I confirm. - required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index ade2563f5..000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,3 +0,0 @@ -- [ ] Check the box to confirm that you are familiar with the [contributing guidelines](https://learn.astropy.org/contributing/) and/or indicate (check the box) that you are familiar with our contributing workflow. -- [ ] Confirm that any contributed tutorials contain a complete Introduction which includes an Author list, Learning Goals, Keywords, Companion Content (if applicable), and a Summary. -- [ ] Check the box to confirm that you are familiar with the Astropy community [code of conduct](https://github.com/astropy/astropy/blob/main/CODE_OF_CONDUCT.md) and you agree to follow the CoC. diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 85ba7862c..000000000 --- a/.gitignore +++ /dev/null @@ -1,12 +0,0 @@ -.ipynb_checkpoints/ -_build/ -IPython-* -*.fits* -*.gz -*.pdf -*.jpg -*.pyc -*.tex -exec*.ipynb -.python-version -.DS_Store diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 585b3cfd1..000000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,37 +0,0 @@ -# See https://pre-commit.com for more information -# See https://pre-commit.com/hooks.html for more hooks - -ci: - autoupdate_commit_msg: "chore: update pre-commit hooks" - autofix_commit_msg: "style: pre-commit fixes" - autofix_prs: true - -repos: - - repo: https://github.com/astral-sh/ruff-pre-commit - rev: "v0.15.1" - hooks: - - id: ruff - types_or: [python, pyi, jupyter] - args: [--fix, --show-fixes] - - id: ruff-format - types_or: [python, pyi, jupyter] - - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v6.0.0 - hooks: - - id: trailing-whitespace - exclude: '.*\.fits$' - - id: end-of-file-fixer - exclude_types: [csv] - exclude: '.*\.fits$' - - id: check-yaml - # prevent addition of (presumably data) files >= 10 MB - # (for such files, see https://learn.astropy.org/contributing/how-to-contribute) - - id: check-added-large-files - args: ["--maxkb=10000"] - - - repo: https://github.com/kynan/nbstripout - rev: 0.9.0 - hooks: - - id: nbstripout - args: ["--extra-keys=metadata.kernelspec metadata.language_info.version metadata.toc"] diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 86d5a44f8..000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -As part of Astropy, the tutorials community members should abide by the [Astropy Project Code of Conduct](http://www.astropy.org/code_of_conduct.html). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ada61eac8..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing - -We welcome both new tutorials covering astronomy-related concepts and improvements to existing tutorials. Please see the [contributing guide](https://learn.astropy.org/contributing) for more information on how to contribute. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 1360259c1..000000000 --- a/LICENSE +++ /dev/null @@ -1,29 +0,0 @@ -BSD 3-Clause License - -Copyright (c) 2019–2022, The Astropy Project -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md deleted file mode 100644 index 254db01f1..000000000 --- a/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Astropy Tutorials - -This repo is used for discussion of topics relating to Learn Astropy, but not specific to a single tutorial. Please open an issue to raise a topic. If you would instead like to raise an issue about a specific tutorial, please do so in that tutorial's `tutorial--*` respository. If you would like to contribute a new tutorial, see the [contribution guide](https://learn.astropy.org/contributing/). - -For developers, this repo also contains scripts and resources used across all tutorials - see the [dev guide](https://github.com/astropy-learn/dev-guide). - -## Site infrastructure status -- learn-astropy [![Deploy](https://github.com/astropy-learn/learn-astropy/actions/workflows/deploy.yaml/badge.svg)](https://github.com/astropy-learn/learn-astropy/actions/workflows/deploy.yaml) -- learn-astropy-librarian [![CI](https://github.com/astropy-learn/learn-astropy-librarian/actions/workflows/ci.yaml/badge.svg)](https://github.com/astropy-learn/learn-astropy-librarian/actions/workflows/ci.yaml) - -## Tutorials build status -- astropy-coordinates [![Build notebook](https://github.com/astropy-learn/tutorial--astropy-coordinates/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--astropy-coordinates/actions/workflows/build.yml) -- astropy-modeling [![Build notebook](https://github.com/astropy-learn/tutorial--astropy-modeling/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--astropy-modeling/actions/workflows/build.yml) -- catalog-overlay-on-fits [![Build notebook](https://github.com/astropy-learn/tutorial--catalog-overlay-on-fits/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--catalog-overlay-on-fits/actions/workflows/build.yml) -- color-excess [![Build notebook](https://github.com/astropy-learn/tutorial--color-excess/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--color-excess/actions/workflows/build.yml) -- FITS-cubes [![Build notebook](https://github.com/astropy-learn/tutorial--FITS-cubes/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--FITS-cubes/actions/workflows/build.yml) -- FITS-header [![Build notebook](https://github.com/astropy-learn/tutorial--FITS-header/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--FITS-header/actions/workflows/build.yml) -- FITS-images [![Build notebook](https://github.com/astropy-learn/tutorial--FITS-images/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--FITS-images/actions/workflows/build.yml) -- FITS-tables [![Build notebook](https://github.com/astropy-learn/tutorial--FITS-tables/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--FITS-tables/actions/workflows/build.yml) -- gaia-galactic-orbits [![Build notebook](https://github.com/astropy-learn/tutorial--gaia-galactic-orbits/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--gaia-galactic-orbits/actions/workflows/build.yml) -- gaia-visualization [![Build notebook](https://github.com/astropy-learn/tutorial--gaia-visualization/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--gaia-visualization/actions/workflows/build.yml) -- plot-catalog [![Build notebook](https://github.com/astropy-learn/tutorial--plot-catalog/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--plot-catalog/actions/workflows/build.yml) -- position-velocity-diagrams [![Build notebook](https://github.com/astropy-learn/tutorial--position-velocity-diagrams/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--position-velocity-diagrams/actions/workflows/build.yml) -- quantities [![Build notebook](https://github.com/astropy-learn/tutorial--quantities/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--quantities/actions/workflows/build.yml) -- redshift-plot [![Build notebook](https://github.com/astropy-learn/tutorial--redshift-plot/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--redshift-plot/actions/workflows/build.yml) -- spectral-cube-reprojection [![Build notebook](https://github.com/astropy-learn/tutorial--spectral-cube-reprojection/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--spectral-cube-reprojection/actions/workflows/build.yml) -- spectroscopic-data-reduction-basics [![Build notebook](https://github.com/astropy-learn/tutorial--spectroscopic-data-reduction-basics/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--spectroscopic-data-reduction-basics/actions/workflows/build.yml) -- synthetic-images [![Build notebook](https://github.com/astropy-learn/tutorial--synthetic-images/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--synthetic-images/actions/workflows/build.yml) -- units-and-integration [![Build notebook](https://github.com/astropy-learn/tutorial--units-and-integration/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--units-and-integration/actions/workflows/build.yml) -- UVES [![Build notebook](https://github.com/astropy-learn/tutorial--UVES/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--UVES/actions/workflows/build.yml) -- vo [![Build notebook](https://github.com/astropy-learn/tutorial--vo/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--vo/actions/workflows/build.yml) -- wcs-celestial-coordinates [![Build notebook](https://github.com/astropy-learn/tutorial--wcs-celestial-coordinates/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--wcs-celestial-coordinates/actions/workflows/build.yml) -- working-with-large-FITS-files [![Build notebook](https://github.com/astropy-learn/tutorial--working-with-large-FITS-files/actions/workflows/build.yml/badge.svg)](https://github.com/astropy-learn/tutorial--working-with-large-FITS-files/actions/workflows/build.yml) diff --git a/_config.yml b/_config.yml deleted file mode 100644 index d7b5a872d..000000000 --- a/_config.yml +++ /dev/null @@ -1,37 +0,0 @@ -title: -author: -logo: logo.svg -execute: - execute_notebooks: force -# repository: -# url: -# branch: main -# html: -# use_repository_button: true -# use_issues_button: true -# use_edit_page_button: true -# home_page_in_navbar: true -# analytics: -# google_analytics_id: "G-ZBXC3EFGGJ" -# launch_buttons: -# notebook_interface: jupyterlab -# thebe: true -sphinx: - config: - html_show_copyright: false - nb_execution_raise_on_error: true # raise error if a notebook cell fails to execute - nb_execution_timeout: 600 # max time [s] to wait for a cell to execute; raises error if exceeded - html_theme_options: - use_repository_button: true - use_issues_button: true - use_edit_page_button: true - analytics: - google_analytics_id: "G-ZBXC3EFGGJ" - launch_buttons: - notebook_interface: jupyterlab - thebe: true - repository_url: - repository_branch: main - logo: - link: "https://learn.astropy.org" - alt_text: "Learn Astropy" diff --git a/images/logo.svg b/images/logo.svg deleted file mode 100644 index 16ecdaa88..000000000 --- a/images/logo.svg +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - diff --git a/index.html b/index.html new file mode 100644 index 000000000..9ebd40909 --- /dev/null +++ b/index.html @@ -0,0 +1,7 @@ + + + + + + diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index 9c411e86a..000000000 --- a/requirements-dev.txt +++ /dev/null @@ -1,2 +0,0 @@ -jupyter-book>=1.0.4,<2.0 -pre-commit diff --git a/resources/keywords.md b/resources/keywords.md deleted file mode 100644 index 8935d4d4e..000000000 --- a/resources/keywords.md +++ /dev/null @@ -1,67 +0,0 @@ -# Astropy package keywords -aplpy -astroplan -astroquery -convolution -coordinates -dust extinction -gala -imexam -modeling -photutils -reproject -spectral cube -specutils -synphot -table -time -units -vo conesearch -wcs - -# Python package keywords -dask -matplotlib -numpy -scipy - -# Task keywords -colorbar -contour plots -data cubes -error bars -file input/output -FITS -histogram -image analysis -image manipulation -LaTeX -model fitting -modular code -OOP -photometry -pv diagram -scalebar -scatter plots -Simbad -spectroscopy -time series -units -Vizier - -# Science keywords -astrodynamics -astrometry -astrostatistics -extinction -galactic astronomy -galaxy dynamics -IR and optical astronomy -observational astronomy -physics -polarimetry -radio astronomy -stellar evolution -stellar photometry -stellar physics -x-ray astronomy diff --git a/scripts/execute-convert.py b/scripts/execute-convert.py deleted file mode 100644 index 5da680f20..000000000 --- a/scripts/execute-convert.py +++ /dev/null @@ -1,52 +0,0 @@ -import subprocess -import sys -import glob - -slug = sys.argv[1] - - -def run_command(command, verbose=1): - try: - result = subprocess.run(command, check=True, capture_output=True, text=True) - except subprocess.CalledProcessError as e: - print(f"Error building book: {e.stderr}") - sys.exit(1) - if verbose > 0: - print(f"Output: {result.stdout}") - return result - - -notebooks = glob.glob("*.ipynb") -if len(notebooks) > 1: - print("More than one .ipynb notebook found --> assuming this is a book") - - # build book - command = [ - "jb", - "build", - "--config", - "_config.yml", - "--toc", - "_toc.yml", - ".", - ] - run_command(command) - - # copy build outputs to 'html' dir - command = ["cp", "-r", "_build/html", "html"] - run_command(command) - -else: - # build single notebook - command = [ - "jb", - "build", - "--config", - "_config.yml", - f"{slug}.ipynb", - ] - run_command(command) - - # copy build outputs to 'html' dir - command = ["cp", "-r", f"_build/_page/{slug}/html", "html"] - run_command(command) diff --git a/scripts/pre-process.py b/scripts/pre-process.py deleted file mode 100644 index cf21ec94e..000000000 --- a/scripts/pre-process.py +++ /dev/null @@ -1,25 +0,0 @@ -import yaml - -with open("AUTHORS.md", "r") as f: - authors = f.read().replace("\n", " ").strip(" ") - -with open("metadata.yml", "r") as f: - meta = yaml.load(f, Loader=yaml.SafeLoader) - -# populate _config with tutorial-specific metadata -with open("astropy-tutorials/_config.yml") as f: - cfg = yaml.load(f, Loader=yaml.SafeLoader) - -cfg["title"] = meta["title"] -cfg["author"] = authors -# cfg["repository"]["url"] = f"https://github.com/astropy-learn/{meta['source']}" -cfg["sphinx"]["config"]["html_theme_options"]["repository_url"] = ( - f"https://github.com/astropy-learn/{meta['source']}" -) - -# save populated '_config.yml' in the target repo -with open("_config.yml", "w") as f: - cfg = yaml.dump(cfg, stream=f, default_flow_style=False, sort_keys=False) - -# for use by subsequent github actions job -print(meta["slug"]) diff --git a/templates/index.tpl b/templates/index.tpl deleted file mode 100644 index e4c780fb8..000000000 --- a/templates/index.tpl +++ /dev/null @@ -1,14 +0,0 @@ - - - - -Astropy tutorials - - - - -