diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..de0c122 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,46 @@ +# This file was created automatically with `myst init --gh-pages` 🪄 💚 + +name: MyST GitHub Pages Deploy +on: + push: + # Runs on pushes targeting the default branch + branches: [main] +env: + # `BASE_URL` determines the website is served from, including CSS & JS assets + # You may need to change this to `BASE_URL: ''` + BASE_URL: /${{ github.event.repository.name }} + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: 'pages' + cancel-in-progress: false +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v3 + - uses: actions/setup-node@v4 + with: + node-version: 18.x + - name: Install MyST Markdown + run: npm install -g mystmd + - name: Build HTML Assets + run: myst build --html + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: './_build/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.gitignore b/.gitignore index 82f9275..e6a3a62 100644 --- a/.gitignore +++ b/.gitignore @@ -160,3 +160,6 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +# MyST build outputs +_build diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..ac57b96 --- /dev/null +++ b/environment.yml @@ -0,0 +1,22 @@ +name: cape-k-student-workshop-2025-dev +channels: + - conda-forge +dependencies: + - jupyter + - mystmd + - jupyterlab + - xarray + - matplotlib + - dask + - distributed + - arm_pyart + - act-atmos + - metpy + - siphon + - cartopy + - emc2 + - cmweather + - myst-parser + - pip + - pip: + - git+https://github.com/eagles-project/ESMAC_diags diff --git a/images/arm_logo.png b/images/arm_logo.png new file mode 100644 index 0000000..8b95ec1 Binary files /dev/null and b/images/arm_logo.png differ diff --git a/myst.yml b/myst.yml new file mode 100755 index 0000000..c9a0356 --- /dev/null +++ b/myst.yml @@ -0,0 +1,37 @@ +version: 1 +extends: + - https://raw.githubusercontent.com/projectpythia-mystmd/pythia-config/main/pythia.yml +project: + title: ERAD 2024 + github: https://github.com/ARM-Development/cape-k-student-workshop-2025 + authors: + - name: Maxwell Grover + orcid: 0000-0002-0370-8974 + github: mgrover1 + - name: Scott Collis + orcid: 0000-0002-2303-687X + github: scollis + copyright: '2024' + toc: + - file: README.md + - file: schedule.md + jupyter: + binder: + repo: ARM-Development/cape-k-student-workshop-2025 + url: https://binder.projectpythia.org/ + abbreviations: + ARM: Atmospheric Radiation Measurement + settings: + output_matplotlib_strings: remove +site: + options: + logo: images/arm_logo.png + nav: + - title: ARM Home + url: https://www.arm.gov/ + - title: ARM Cape-k Website + url: https://www.arm.gov/research/campaigns/amf2024cape-k + actions: + - title: Launch Environment + url: https://binder.projectpythia.org/v2/gh/ARM-Development/cape-k-student-workshop-2025/main?labpath=notebooks + diff --git a/notebooks/README.md b/notebooks/README.md new file mode 100644 index 0000000..401fbd8 --- /dev/null +++ b/notebooks/README.md @@ -0,0 +1,2 @@ +# Notebooks +A place to store notebooks for the student workshop