Skip to content

Commit 115c24a

Browse files
Merge branch 'develop' into quarto-meta-analysis-demo
2 parents 9e0dd6f + 8e2f6a0 commit 115c24a

30 files changed

+165
-11
lines changed

.github/lychee.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Lychee link checker configuration for PEcAn project
2+
# See https://lychee.cli.rs for more options
3+
4+
# Don't fail on certificate issues (some sites have temporary cert problems)
5+
insecure = true
6+
7+
8+
# Exclude patterns (regex) - add domains/URLs that frequently have transient failures
9+
exclude = [
10+
# Localhost URLs (local development only)
11+
'localhost/*',
12+
'127\.0\.0\.1/*',
13+
'pecan\.localhost/*',
14+
]

.github/workflows/check-links.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Check Documentation Links (Periodic Checks)
2+
3+
on:
4+
# Run weekdays at 10:00 UTC
5+
schedule:
6+
- cron: '0 10 * * 1-5'
7+
# Allow manual trigger
8+
workflow_dispatch:
9+
# Run on PR changes to link checker config
10+
pull_request:
11+
paths:
12+
- '.github/lychee.toml'
13+
- '.github/workflows/check-links.yml'
14+
15+
jobs:
16+
links-checker:
17+
# Only run on main repository for scheduled runs
18+
if: ${{ github.repository == 'PecanProject/pecan' || github.event_name != 'schedule' }}
19+
20+
env:
21+
ISSUE_NAME: 'Documentation: broken links automatic report'
22+
23+
runs-on: ubuntu-latest
24+
25+
permissions:
26+
issues: write # Required for creating/updating/closing issues
27+
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
with:
32+
fetch-depth: 0 # Fetch all history for complete link checking
33+
34+
- name: Links Checker
35+
id: lychee
36+
uses: lycheeverse/lychee-action@v2
37+
with:
38+
args: --config .github/lychee.toml './**/*.md' './**/*.html' './**/*.Rmd' './**/*.R' './**/*.qmd'
39+
fail: false
40+
41+
# Search for existing open issue to avoid creating duplicates
42+
- name: Search for existing issue number
43+
id: search-issue
44+
run: |
45+
encoded_issue_name=$(echo "$ISSUE_NAME" | sed 's/ /%20/g')
46+
response=$(curl -s -X GET "https://api.github.com/search/issues?q=$encoded_issue_name+repo:PecanProject/pecan+state:open+label:automated-issue&type=Issues")
47+
issue_number=$(echo "$response" | jq -r '.items[0].number // empty')
48+
echo "issue_number=$issue_number" >> $GITHUB_OUTPUT
49+
50+
# Create new issue or update existing one
51+
- name: Create or update issue with report
52+
uses: peter-evans/create-issue-from-file@v5
53+
if: steps.lychee.outputs.exit_code != 0
54+
with:
55+
title: ${{ env.ISSUE_NAME }}
56+
content-filepath: ./lychee/out.md
57+
issue-number: ${{ steps.search-issue.outputs.issue_number }}
58+
labels: automated-issue
59+
60+
# Auto-close issue when all links are fixed
61+
- name: Close automated issue
62+
if: steps.lychee.outputs.exit_code == 0 && steps.search-issue.outputs.issue_number != ''
63+
uses: peter-evans/close-issue@v3
64+
with:
65+
issue-number: ${{ steps.search-issue.outputs.issue_number }}
66+
comment: '[Periodic links check](https://github.com/PecanProject/pecan/actions/workflows/check-links.yml) no longer finds broken links, closing issue.'
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Running PEcAn Basic Run using Quarto {#run-demo-1}
2+
3+
This guide explains how to run the **Basic Run** tutorial using the new Quarto notebook format.
4+
5+
### Prerequisites
6+
7+
To run this notebook interactively, you will need:
8+
9+
[**RStudio**](https://posit.co/download/rstudio-desktop/): An integrated development environment for R.
10+
11+
### Steps to Run
12+
13+
1. **Open in RStudio**:
14+
Open the [`run_pecan.qmd`](https://github.com/PecanProject/pecan/blob/develop/documentation/tutorials/Demo_1_Basic_Run/run_pecan.qmd) file in RStudio.
15+
16+
2. **Run Interactively**:
17+
You can run separate chunks and go through the comments of every section to understand the notebook better.
18+
19+
3. **Render the Notebook**:
20+
21+
To render the notebook to HTML, run the following command in your terminal:
22+
```bash
23+
quarto render documentation/tutorials/Demo_1_Basic_Run/run_pecan.qmd
24+
```
25+
26+
### View Generated Artifact
27+
28+
If you prefer to view the pre-rendered output without running the code yourself, you can access the generated HTML artifact here:
29+
30+
[**View Rendered Notebook (HTML)**](https://pecanproject.github.io/pecan-documentation/develop/rendered-demo-notebooks/run_pecan.html)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Running Uncertainty Analysis using Quarto {#run-demo-2}
2+
3+
This guide explains how to run the **Uncertainty Analysis** tutorial using the new Quarto notebook format.
4+
5+
### Prerequisites
6+
7+
To run this notebook interactively, you will need:
8+
9+
[**RStudio**](https://posit.co/download/rstudio-desktop/): An integrated development environment for R.
10+
11+
### Steps to Run
12+
13+
1. **Open in RStudio**:
14+
Open the [`uncertainty.qmd`](https://github.com/PecanProject/pecan/blob/develop/documentation/tutorials/Demo_02_Uncertainty_Analysis/uncertainty.qmd) file in RStudio.
15+
16+
2. **Run Interactively**:
17+
You can run separate chunks and go through the comments of every section to understand the notebook better.
18+
19+
3. **Render the Notebook**:
20+
To render the notebook to HTML, run the following command in your terminal:
21+
22+
```bash
23+
quarto render documentation/tutorials/Demo_02_Uncertainty_Analysis/uncertainty.qmd
24+
```
25+
26+
### View Generated Artifact
27+
28+
If you prefer to view the pre-rendered output without running the code yourself, you can access the generated HTML artifact here:
29+
30+
[**View Rendered Notebook (HTML)**](https://pecanproject.github.io/pecan-documentation/develop/rendered-demo-notebooks/uncertainty.html)

book_source/02_demos_tutorials_workflows/02_user_demos/02_Demo_Basic_Run renamed to book_source/02_demos_tutorials_workflows/02_user_demos/04_Demo_Basic_Run

File renamed without changes.

book_source/02_demos_tutorials_workflows/02_user_demos/03_Demo_Uncertainty_Analysis renamed to book_source/02_demos_tutorials_workflows/02_user_demos/05_Demo_Uncertainty_Analysis

File renamed without changes.

book_source/02_demos_tutorials_workflows/02_user_demos/04_other_vignettes/00_other_vignettes.Rmd renamed to book_source/02_demos_tutorials_workflows/02_user_demos/06_other_vignettes/00_other_vignettes.Rmd

File renamed without changes.

book_source/02_demos_tutorials_workflows/02_user_demos/04_other_vignettes/01_model-data_comparison.Rmd renamed to book_source/02_demos_tutorials_workflows/02_user_demos/06_other_vignettes/01_model-data_comparison.Rmd

File renamed without changes.

book_source/02_demos_tutorials_workflows/02_user_demos/04_other_vignettes/02_data_assimilation_concepts.Rmd renamed to book_source/02_demos_tutorials_workflows/02_user_demos/06_other_vignettes/02_data_assimilation_concepts.Rmd

File renamed without changes.

book_source/02_demos_tutorials_workflows/02_user_demos/04_other_vignettes/03_parameter_data_assimilation.Rmd renamed to book_source/02_demos_tutorials_workflows/02_user_demos/06_other_vignettes/03_parameter_data_assimilation.Rmd

File renamed without changes.

0 commit comments

Comments
 (0)