Skip to content

Commit 4de6927

Browse files
committed
🚀 Initial content from WG
1 parent e114811 commit 4de6927

File tree

11 files changed

+287
-5
lines changed

11 files changed

+287
-5
lines changed

.github/workflows/deploy.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# This file was created automatically with `myst init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: MyST GitHub Pages Deploy
5+
on:
6+
push:
7+
# Runs on pushes targeting the default branch
8+
branches: [main]
9+
env:
10+
# `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
11+
# E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
12+
# If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
13+
BASE_URL: /${{ github.event.repository.name }}
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: 'pages'
24+
cancel-in-progress: false
25+
jobs:
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v3
35+
- uses: actions/setup-node@v4
36+
with:
37+
node-version: 18.x
38+
- name: Install MyST
39+
run: npm install -g mystmd
40+
- name: Build HTML Assets
41+
run: myst build --html
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: './_build/html'
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# MyST build outputs
2+
_build

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ Use the group [GitHub repository](https://github.com/force11/pircwg) for documen
66

77
The group started in March 2025 and is planning to conclude by August/September 2026.
88

9+
![](./increasing-interactivity-dial.png)
10+
911
## Description
10-
Research is often more than the text content, and can include both the software and computational environments to reproduce work. These can be shared by researchers as computational notebooks, however, scholarly communications infrastructure is currently poorly positioned to both display, interact with, and archive that content. The next-generation of executable research content in scientific publishing requires comprehensive strategies, guidelines, and frameworks to ensure long-term preservation of the scientific record.
12+
13+
Research is often more than the text content, and can include both the software and computational environments to reproduce work. These can be shared by researchers as computational notebooks, however, scholarly communications infrastructure is currently poorly positioned to both display, interact with, and archive that content. The next-generation of interactive and executable research content in scientific publishing requires comprehensive strategies, guidelines, and frameworks to ensure long-term preservation of the scientific record.
1114

1215
This working group will cover and work towards:
1316

@@ -19,17 +22,20 @@ This working group will cover and work towards:
1922
During this process, the plans may be updated based on feedback from the activities.
2023

2124
## Core Group members
25+
2226
- Sam Teplitzky (co-chair), Open Science Librarian, UC Berkeley
2327
- Rowan Cockett (co-chair), Cofounder and CEO, Curvenote
2428
- Catherine Jones, UKERC Energy Data Centre Lead at STFC
2529
- Roly Perera, Institute of Computing for Climate Science, Research Fellow in the Department of Computer Science and Technology, University of Cambridge
2630
- Virginia Scarlett, Open Source Programs Specialist, University of California, Santa Barbara
2731
- Manuela Pallotto Strickland, Metadata and Digital Preservation Coordinator, King's College London
2832
- Kirstie Whitaker, Executive Director, Berkeley Institute for Data Science, UC Berkeley
29-
33+
3034
## Meetings
35+
3136
### Virtual
32-
Monthly virtual core group meetings are generally held at 09:00 Pacific / Noon Eastern / 16:00 UTC / 17:00 BST on 3rd Tuesdays.
37+
38+
Monthly virtual core group meetings are generally held at 09:00 Pacific / Noon Eastern / 16:00 UTC / 17:00 BST on 3rd Tuesdays.
3339

3440
General meetings TBD, planned to begin ~ Sept/Oct 2025
3541

@@ -38,9 +44,11 @@ Meeting agendas and minutes can be found at: TBD
3844
**Zoom information:** TBD
3945

4046
### In-person Meetings
47+
4148
TBD but may be organized to coincide with Force11 meetings.
4249

4350
## Timeline
51+
4452
(subject to change)
4553

4654
- January - March 2025: Launch. Recruit interested members and form core working group.
@@ -51,8 +59,7 @@ TBD but may be organized to coincide with Force11 meetings.
5159
- 2026: Evaluation and Finalizing outcomes
5260

5361
## What we need
62+
5463
TBD
5564

5665
## Group Products
57-
58-

banner.png

754 KB
Loading

definitions.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Definitions
3+
---
4+
5+
Here we list some of the terms and definitions in this context.
6+
7+
:::{glossary}
8+
Preservation
9+
: Preservation, in this context, is defined as “the activity or process of keeping something valued alive, intact, or free from damage or {term}`decay`” ([https://www.merriam-webster.com/dictionary/preservation](https://www.merriam-webster.com/dictionary/preservation)). Preserving digital content is an active process as this content needs to be monitored, changed and migrated to ensure access remains stable. Content needs to be of enough interest, or value, to others for this process to be supported and funded. The outcomes of the preservation actions should minimize any damage and ensure that the object remains useful for the intended audience over time. The actions that might be undertaken for preservation will align with the concept of {term}`graceful degradation`, mitigating the challenges of maintaining access while preserving interactivity when possible.
10+
11+
Graceful Degradation
12+
: The idea that complex systems can fail or simplify _incrementally_—not catastrophically {term}`decay`. It’s about designing systems that provide the richest experience possible when everything works (e.g. {term}`Interactive Research Content`), while still offering meaningful, functional fallback options when conditions change.
13+
14+
Decay
15+
: Decay is not the same as {term}`Graceful degradation`, as GD implies _decay management_. Decay just happens, whereas GD is a response to decay (i.e. decay stewarding).
16+
17+
Interactive Research Content
18+
: An interactive research product is one that allows the research content, or the way that content is displayed, to change as a result of user input. Any change that results from user input, even a cosmetic change, counts as interactivity if it clarifies the work or deepens the user’s understanding of the work. However, in the context of the Preserving Interactive Research Content WG, we are mainly focused on user inputs that enhance memorability or understanding, and not merely readability (e.g. light/dark mode, font size). The research product must be designed with user input in mind, and make it easy for the user to customize their own experience.
19+
20+
In other words, an interactive research product must:
21+
22+
* Enhance our understanding of a particular concept or dataset
23+
* Solicit and “respond” to user input, allowing the user to customize their experience
24+
* Be designed with user input in mind, making that input easy to provide
25+
26+
:::
27+
28+
### Is it Interactive Research Content (IRC)?
29+
30+
| Output | IRC? | Explanation |
31+
| :------------------------------------------------------------------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
32+
| PDF (with links to downloadable code and data) | No | Research is displayed the same for all users Source code is available but not easy for users to change their experience |
33+
| Downloadable binary executable | No | Research is displayed the same for all users Source code is available but not easy for users to change their experience |
34+
| JATS/Metadata | No | Increases understanding, potentially drives interactivity (and accessibility) but is not interactive itself |
35+
| Website with research results | Usually | When user can change display of data or ideas to enhance understanding |
36+
| PDF research article with widgets | Yes | Static product with interactive components |
37+
| Application or dashboard with data built-in | Yes | Research display varies based on user input |
38+
| Excel spreadsheet | Yes, typically | User responds immediately to changes in the raw data (or formulae) by updating any dependent content, such as other cells, or charts. Affordances available to end-users, not just the spreadsheet developer. |
39+
| Multiverse analyses | Yes, ideally | User considers multiple analysis pathways including selection of variables and statistical models. Enabled by IRC. |
40+
| Notebook with research code and results \- “Explorable Explanations” | Sometimes | A notebook with widgets, zoomable images, or empty input fields **is IRC**. If designed to be run on the command line, or perhaps published as a static PDF or HTML, is **not IRC** because it is not designed to solicit and react to user input. A program that just happens to be easier to edit simply by virtue of being in a notebook format is **not IRC**. |
41+
| Package or library | Sometimes | If the package is designed to enhance user understanding of a particular research product by responding to user input, then **it is IRC**. A package that “merely” serves as an interface for research data, and is not designed to enhance our understanding of any particular study or studies, **is not IRC**. This is a research tool, and while research tools are extremely useful research products, they are not research content per se. |
42+
| Dockerized program | Sometimes | A program designed to solicit and respond to user input for the purpose of enhancing user understanding **is IRC**. A program that was designed to run in batched or non-interactive mode does not become interactive simply because it was containerized. |

0 commit comments

Comments
 (0)