Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 52 additions & 39 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,59 @@
name: deploy-book
# This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.

# Only run this when the master branch changes
name: Jupyter Book (via myst) GitHub Pages Deploy
on:
push:
branches:
- main
# If your git repository has the Jupyter Book within some-subfolder next to
# unrelated files, you can make this run only if a file within that specific
# folder has been modified.
#
# paths:
# - some-subfolder/**
# Runs on pushes targeting the default branch
branches: [main]
env:
# `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
# E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
# If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
BASE_URL: /${{ github.event.repository.name }}

# This job installs dependencies, build the book, and pushes it to `gh-pages`
# 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-book:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

# Install dependencies
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install dependencies
run: |
pip install -r docs/requirements.txt

# Build the book
- name: Build the book
env: # Set secret environment variables
BSRN_FTP_USERNAME: ${{ secrets.BSRN_FTP_USERNAME }}
BSRN_FTP_PASSWORD: ${{ secrets.BSRN_FTP_PASSWORD }}
run: |
jupyter-book build docs/.

# Push the book's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
cname: SolarStations.Org
- uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: actions/setup-node@v4
with:
node-version: 18.x
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: pip install -r docs/requirements.txt
- name: Install mystmd
run: npm install -g mystmd
- name: Build HTML Assets
env: # Set secret environment variables
BSRN_FTP_USERNAME: ${{ secrets.BSRN_FTP_USERNAME }}
BSRN_FTP_PASSWORD: ${{ secrets.BSRN_FTP_PASSWORD }}
run: cd docs && myst build --html --execute
- name: Add CNAME
run: echo 'SolarStations.org' > ./docs/_build/html/CNAME
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
docs/_build/*
# MyST build outputs
docs/_build
docs/station-listing.csv # auto-generated by docs build
.ipynb_checkpoints
.DS_Store
__pycache__/
SolarStationsOrg-station-catalog.csv


# MyST build outputs
_build
30 changes: 15 additions & 15 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
jobs:
pre_build:
# Generate the Sphinx configuration for this Jupyter Book so it builds.
- "jupyter-book config sphinx docs/"

python:
install:
- requirements: docs/requirements.txt

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/_config.yml
builder: html
fail_on_warning: true
python: "3.13"
nodejs: "22"
commands:
# Install Python dependencies
- pip install -r docs/requirements.txt
# Install mystmd
- npm install -g mystmd
# Build the site (myst.yml lives in docs/, so build from there)
# --execute re-runs notebook code cells instead of using their stored outputs.
- cd docs && myst build --html --execute
# Copy the output to Read the Docs expected location
- mkdir -p $READTHEDOCS_OUTPUT/html/
- cp -r docs/_build/html/. "$READTHEDOCS_OUTPUT/html"
# Clean up build artifacts
- rm -rf docs/_build
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Solar Stations
A catalog of multi-component solar irradiance monitoring stations.

An interactive map and catalog of the stations can be found at [SolarStations.Org](https://SolarStations.Org).
An interactive map and catalog of the stations can be found at [SolarStations.org](https://SolarStations.org).

Pull requests with new stations or updates are highly welcome!

Expand Down
34 changes: 0 additions & 34 deletions docs/_config.yml

This file was deleted.

49 changes: 0 additions & 49 deletions docs/_toc.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"id": "6a1101b1-fdf8-4389-a1ce-a7f997cd3b4a",
"metadata": {
"tags": [
"hide-input",
"remove-input"
]
},
Expand Down
70 changes: 70 additions & 0 deletions docs/myst.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# See docs at: https://mystmd.org/guide/frontmatter
version: 1
project:
id: 38f67f99-53eb-411b-bbf0-4734d647712d
title: SolarStations.org
authors:
- name: Adam R. Jensen
email: arajen@dtu.dk
corresponding: true
- name: Ioannis Sifnaios
- name: Kevin Anderson
copyright: "2022"
open_access: true
license: BSD-3-Clause
# doi:
# description:
# keywords: []
github: https://github.com/AssessingSolar/

settings:
output_matplotlib_strings: remove

toc:
- file: intro.ipynb
- file: station_catalog.ipynb
- file: station_requirements.md
title: Station requirements
- file: station_metadata.md
- file: station_statistics.ipynb
title: Statistics

- title: Networks
children:
- file: station_network_bsrn.ipynb
title: BSRN
- file: station_network_esmap.ipynb
title: ESMAP
- file: station_network_midc.ipynb
title: NREL MIDC
- file: station_network_solrad.ipynb
title: SOLRAD
- file: station_network_srml.ipynb
title: SRML
- file: station_network_surfrad.ipynb
title: SURFRAD

- title: Other data sources
children:
- file: station_network_pvlive.ipynb
- file: station_network_eye2sky.ipynb
title: Eye2sky
- file: geba_network.md
- file: other_data_sources.md
title: Miscellaneous

- title: Appendix
children:
- file: contributing.md
- title: pvlib iotools
url: https://assessingsolar.org
- title: IEA PVPS Task 16
url: https://iea-pvps.org/research-tasks/solar-resource-for-high-penetration-and-large-scale-applications/

site:
template: book-theme
options:
favicon: graphics/solarstationsorg_favicon.ico
logo: graphics/solarstationsorg_logo_padded.png
analytics_google: G-6KXSD7FTJM
hide_authors: true
2 changes: 0 additions & 2 deletions docs/other_data_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ This page provides information about alternative sources for obtaining irradianc

* [CANSIM](https://pubs.aip.org/aip/acp/article/1881/1/090002/794031/Deployment-and-early-results-from-the-CanSIM) is a Canadian network with 7 stations measuring spectral irradiance using Spectrafy sensors.

* Eye2Sky ([link_1](https://www.dlr.de/en/images/2019/4/the-eye2sky-measurement-network-will-comprise-34-stations-when-complete), [link_2](https://www.dlr.de/en/ve/research-and-transfer/research-infrastructure/laboratories-infrastructures/eye2sky)) is a network of all-sky cameras near Oldenburg, Germany. A third of the stations are equipped with a rotating shadowband irradiometer (RSI) for measuring solar irradiance.

* [Oklahoma Mesonet](https://www.mesonet.org/weather/solar-radiation-satellite/solar-radiation) is a network of weather stations equipped with LI-COR pyranometers. Information about this network is also given [here](https://journals.ametsoc.org/view/journals/atot/17/4/1520-0426_2000_017_0474_qapito_2_0_co_2.xml).

* [German Weather Services - Deutscher Wetterdienst (DWD)](https://www.dwd.de/DE/leistungen/solarenergie/Strahlungsmessnetz.html?nn=495490) operates a network of 120 sites measuring global horizontal irradiance and diffuse irradiance with thermopile pyranometers with a resolution of 10 minutes. Data can be downloaded from [here](https://cdc.dwd.de/portal/)
Expand Down
26 changes: 9 additions & 17 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
folium==0.17.0
ipykernel==6.29.5
ipython==8.28.0
folium==0.20.0
itables==2.2.2
jupyter-book==1.0.3
jupyter-book==2.1.6
kgcpy==1.1.8
lxml==5.3.0
matplotlib==3.9.2
myst-nb==1.1.2
numpy==2.1.2
pandas==2.2.3
pvlib==0.11.1
pyarrow==17.0.0
pydata-sphinx-theme==0.15.4
Sphinx==7.4.7
sphinx-book-theme==1.1.3
unidecode==1.3.8
xarray==2024.5.0
matplotlib==3.11.1
numpy==2.5.1
pandas==3.0.3
pvlib==0.15.2
unidecode==1.4.0
openpyxl==3.1.5
h5netcdf==1.5.0
xarray==2026.7.0
h5netcdf==1.8.1
11 changes: 2 additions & 9 deletions docs/station_catalog.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@
"metadata": {
"tags": []
},
"source": [
"# Station catalog\n",
"\n",
"This site provides an overview of available solar irradiance monitoring stations worldwide and metadata of the stations.\n",
"The metadata fields are further described in the [metadata](station_metadata) section.\n",
"\n",
"The table is also available to download in CSV form: {download}`SolarStationsOrg-station-catalog.csv`"
]
"source": "# Station catalog\n\nThis site provides an overview of available solar irradiance monitoring stations worldwide and metadata of the stations.\nThe metadata fields are further described in the [metadata](station_metadata) section.\n\nThe table is also available to download in CSV form: {download}`SolarStationsOrg-station-catalog.csv <SolarStationsOrg-station-catalog.csv>`"
},
{
"cell_type": "code",
Expand Down Expand Up @@ -436,4 +429,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
}
}
2 changes: 1 addition & 1 deletion docs/station_metadata.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Metadata

The central part of the catalog is the list of stations and their metadata which is displayed on the SolarStations.Org [station catalog page](station_catalog). The metadata for each station includes:
The central part of the catalog is the list of stations and their metadata which is displayed on the SolarStations.org [station catalog page](station_catalog). The metadata for each station includes:
* Station name
* Station abbreviation
* Country and state/region
Expand Down
Loading
Loading