diff --git a/.github/workflows/nightly-build.yaml b/.github/workflows/nightly-build.yaml index 7af78771..990e7eba 100644 --- a/.github/workflows/nightly-build.yaml +++ b/.github/workflows/nightly-build.yaml @@ -9,8 +9,10 @@ jobs: build: if: ${{ github.repository_owner == 'ProjectPythia' }} uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main - with: - environment_name: cookbook-dev + + deploy: + needs: build + uses: ProjectPythia/cookbook-actions/.github/workflows/deploy-book.yaml@main link-check: if: ${{ github.repository_owner == 'ProjectPythia' }} diff --git a/.github/workflows/publish-book.yaml b/.github/workflows/publish-book.yaml index 94f4e48a..4e7fd1ee 100644 --- a/.github/workflows/publish-book.yaml +++ b/.github/workflows/publish-book.yaml @@ -10,9 +10,6 @@ on: jobs: build: uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main - with: - use_cached_environment: false - environment_name: unstructured-grid-viz-cookbook-dev deploy: needs: build diff --git a/.github/workflows/trigger-book-build.yaml b/.github/workflows/trigger-book-build.yaml index bd014bf8..c2b08f34 100644 --- a/.github/workflows/trigger-book-build.yaml +++ b/.github/workflows/trigger-book-build.yaml @@ -6,6 +6,6 @@ jobs: build: uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main with: - environment_name: cookbook-dev artifact_name: book-zip-${{ github.event.number }} + base_url: '/${{ github.event.repository.name }}/_preview/${{ github.event.number }}' # Other input options are possible, see ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml diff --git a/.isort.cfg b/.isort.cfg deleted file mode 100644 index 0fc010f7..00000000 --- a/.isort.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[settings] -known_third_party = diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index fe5f4559..00000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,52 +0,0 @@ -repos: - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 - hooks: - - id: trailing-whitespace - - id: end-of-file-fixer - - id: check-docstring-first - - id: check-json - - id: check-yaml - - id: double-quote-string-fixer - - - repo: https://github.com/psf/black - rev: 23.7.0 - hooks: - - id: black - - - repo: https://github.com/keewis/blackdoc - rev: v0.3.8 - hooks: - - id: blackdoc - - - repo: https://github.com/PyCQA/flake8 - rev: 6.0.0 - hooks: - - id: flake8 - - - repo: https://github.com/asottile/seed-isort-config - rev: v2.2.0 - hooks: - - id: seed-isort-config - - - repo: https://github.com/PyCQA/isort - rev: 5.12.0 - hooks: - - id: isort - - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v3.0.0 - hooks: - - id: prettier - additional_dependencies: [prettier@v2.7.1] - - - repo: https://github.com/nbQA-dev/nbQA - rev: 1.7.0 - hooks: - - id: nbqa-black - additional_dependencies: [black] - - id: nbqa-pyupgrade - additional_dependencies: [pyupgrade] - exclude: foundations/quickstart.ipynb - - id: nbqa-isort - additional_dependencies: [isort] diff --git a/README.md b/README.md index 128d7c3b..aeea0e8e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ +# Unstructured Grid Visualization Cookbook +

-# Unstructured Grid Visualization Cookbook - [![nightly-build](https://github.com/ProjectPythia/unstructured-grid-viz-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/unstructured-grid-viz-cookbook/actions/workflows/nightly-build.yaml) [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/unstructured-grid-viz-cookbook.git/main?labpath=notebooks) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10403389.svg)](https://doi.org/10.5281/zenodo.10403389) diff --git a/_config.yml b/_config.yml deleted file mode 100644 index bef5b978..00000000 --- a/_config.yml +++ /dev/null @@ -1,84 +0,0 @@ -# Book settings -# Learn more at https://jupyterbook.org/customize/config.html - -title: Unstructured Grids Visualization Cookbook -description: Comprehensive showcase of workflows and techniques for visualizing Unstructured Grids using UXarray -author: the Project Pythia Community -logo: notebooks/images/logos/pythia_logo-white-rtext.svg -copyright: "2024" - -execute: - # To execute notebooks via a Binder instead, replace 'cache' with 'binder' - execute_notebooks: cache - timeout: 600 - allow_errors: False # cells with expected failures must set the `raises-exception` cell tag - -# Add a few extensions to help with parsing content -parse: - myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html - - amsmath - - colon_fence - - deflist - - dollarmath - - html_admonition - - html_image - - replacements - - smartquotes - - substitution - -sphinx: - config: - linkcheck_ignore: ["https://doi.org/*"] # don't run link checker on DOI links since they are immutable - nb_execution_raise_on_error: true # raise exception in build if there are notebook errors (this flag is ignored if building on binder) - html_favicon: notebooks/images/icons/favicon.ico - html_last_updated_fmt: "%-d %B %Y" - html_theme: sphinx_pythia_theme - html_permalinks_icon: '' - html_theme_options: - home_page_in_toc: true - repository_url: https://github.com/ProjectPythia/unstructured-grid-viz-cookbook/ # Online location of your book - repository_branch: main # Which branch of the repository should be used when creating links (optional) - use_issues_button: true - use_repository_button: true - use_edit_page_button: true - use_fullscreen_button: true - analytics: - google_analytics_id: G-T52X8HNYE8 - github_url: https://github.com/ProjectPythia/unstructured-grid-viz-cookbook - twitter_url: https://twitter.com/project_pythia - icon_links: - - name: YouTube - url: https://www.youtube.com/channel/UCoZPBqJal5uKpO8ZiwzavCw - icon: fab fa-youtube-square - type: fontawesome - launch_buttons: - binderhub_url: https://binder.projectpythia.org - notebook_interface: jupyterlab - extra_navbar: | - Theme by Project Pythia.

- All code in Pythia Cookbooks is licensed under Apache 2.0. All other non-code content is licensed under Creative Commons BY 4.0 (CC BY 4.0).

- logo: - link: https://projectpythia.org - navbar_start: - - navbar-logo - navbar_end: - - navbar-icon-links - navbar_links: - - name: Home - url: https://projectpythia.org - - name: Foundations - url: https://foundations.projectpythia.org - - name: Cookbooks - url: https://cookbooks.projectpythia.org - - name: Resources - url: https://projectpythia.org/resource-gallery.html - - name: Community - url: https://projectpythia.org/index.html#join-us - footer_logos: - NCAR: notebooks/images/logos/NSF-NCAR_Lockup-UCAR-Dark_102523.svg - Unidata: notebooks/images/logos/Unidata_logo_horizontal_1200x300.svg - UAlbany: notebooks/images/logos/UAlbany-A2-logo-purple-gold.svg - footer_start: - - footer-logos - - footer-info - - footer-extra diff --git a/_static/custom.css b/_static/custom.css deleted file mode 100644 index b0e83df1..00000000 --- a/_static/custom.css +++ /dev/null @@ -1,6 +0,0 @@ -.bd-main .bd-content .bd-article-container { - max-width: 100%; /* default is 60em */ -} -.bd-page-width { - max-width: 100%; /* default is 88rem */ -} diff --git a/_static/footer-logo-nsf.png b/_static/footer-logo-nsf.png deleted file mode 100644 index 11c788f2..00000000 Binary files a/_static/footer-logo-nsf.png and /dev/null differ diff --git a/_templates/footer-extra.html b/_templates/footer-extra.html deleted file mode 100644 index 27cb915d..00000000 --- a/_templates/footer-extra.html +++ /dev/null @@ -1,27 +0,0 @@ -
-
-
- Theme by Project Pythia. All code - in Pythia Cookbooks is licensed under - Apache 2.0. All - other non-code content is licensed under - - Creative Commons BY 4.0 (CC BY 4.0). -
-

-
-

- - This material is based upon work supported by the National Science - Foundation under Grant Nos. 2026863 and 2026899. Any opinions, findings, - and conclusions or recommendations expressed in this material are those - of the author(s) and do not necessarily reflect the views of the - National Science Foundation. -

-
-
-
\ No newline at end of file diff --git a/_toc.yml b/_toc.yml deleted file mode 100644 index bac8f544..00000000 --- a/_toc.yml +++ /dev/null @@ -1,26 +0,0 @@ -format: jb-book -root: README -parts: - - caption: Preamble - chapters: - - file: notebooks/how-to-cite - - caption: Introduction to UXarray & Unstructured Grids - chapters: - - file: notebooks/01-intro/01-unstructured-grid-overview - - file: notebooks/01-intro/02-data-structures - - file: notebooks/01-intro/03-data-mapping - - - caption: Methods & Libraries for Unstructured Grid Visualization - chapters: - - file: notebooks/02-methods/01-plotting-libraries - - file: notebooks/02-methods/02-rendering-techniques - - - caption: UXarray Visualization - chapters: - - file: notebooks/03-uxarray-vis/01-plot-api - - file: notebooks/03-uxarray-vis/002-xarray-to-uxarray - - file: notebooks/03-uxarray-vis/02-grid-topology - - file: notebooks/03-uxarray-vis/03-polygons - - file: notebooks/03-uxarray-vis/04-points - - file: notebooks/03-uxarray-vis/07-animations - - file: notebooks/03-uxarray-vis/06-performance diff --git a/environment.yml b/environment.yml index 2b47c956..09344b21 100644 --- a/environment.yml +++ b/environment.yml @@ -11,6 +11,8 @@ dependencies: - jupyter-book - jupyterlab - matplotlib-base + - mystmd + - nodejs - netcdf4 - numba - numpy diff --git a/myst.yml b/myst.yml new file mode 100644 index 00000000..108436e1 --- /dev/null +++ b/myst.yml @@ -0,0 +1,35 @@ +version: 1 +extends: + - https://raw.githubusercontent.com/projectpythia/pythia-config/main/pythia.yml +project: + title: Unstructured Grids Visualization Cookbook + github: https://github.com/projectpythia/unstructured-grid-viz-cookbook + authors: + - name: The Project Pythia Community + copyright: '2024' + toc: + - file: README.md + - title: Preamble + children: + - file: notebooks/how-to-cite.md + - title: Introduction to UXarray & Unstructured Grids + children: + - file: notebooks/01-intro/01-unstructured-grid-overview.ipynb + - file: notebooks/01-intro/02-data-structures.ipynb + - file: notebooks/01-intro/03-data-mapping.ipynb + - title: Methods & Libraries for Unstructured Grid Visualization + children: + - file: notebooks/02-methods/01-plotting-libraries.ipynb + - file: notebooks/02-methods/02-rendering-techniques.ipynb + - title: UXarray Visualization + children: + - file: notebooks/03-uxarray-vis/01-plot-api.ipynb + - file: notebooks/03-uxarray-vis/002-xarray-to-uxarray.ipynb + - file: notebooks/03-uxarray-vis/02-grid-topology.ipynb + - file: notebooks/03-uxarray-vis/03-polygons.ipynb + - file: notebooks/03-uxarray-vis/04-points.ipynb + - file: notebooks/03-uxarray-vis/07-animations.ipynb + - file: notebooks/03-uxarray-vis/06-performance.ipynb + jupyter: + binder: + repo: projectpythia/unstructured-grid-viz-cookbook