UNM-CARC/cyverse · docs
How to use CyVerse cyberinfrastructure: accounts, the Data Store (GoCommands, iCommands, SFTP, WebDAV), the Discovery Environment and VICE i
Open source Repository Open in the app JSON README (API)
About
# CyVerse User Guide { .carc-visually-hidden }
<div class="carc-hero" markdown>
<p class="carc-hero__title">CyVerse User Guide</p>
<p class="carc-hero__tagline">Store, share, and analyze research data with CyVerse: the Data Store, the Discovery Environment and its interactive apps, cloud services, and AI tools.</p>
<div class="carc-actions" markdown>
[:material-account-plus: Create an account](getting-started/account.md){ .md-button .md-button--primary }
[:material-database: Data Store](data-store/index.md){ .md-button }
[:material-monitor-dashboard: Discovery Environment](discovery-environment/index.md){ .md-button }
[:material-lifebuoy: Get help](getting-started/getting-help.md){ .md-button }
</div>
</div>
<div class="grid cards" markdown>
- :material-rocket-launch:{ .lg .middle } __Getting started__
---
What CyVerse is, creating a free account, subscription tiers, and where
to get help.
[:octicons-arrow-right-24: What is CyVerse?](getting-started/what-is-cyverse.md)
[:oct
Details
- Kind
- OKF bundles
- Topic
- Files & documents
- Publisher
- unm-carc
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Last push
- 2026-09-11T13:54:01Z
- Repository state
- ativo
- Language
- Python
- License
- NOASSERTION
- Added
- 2026-09-13 14:03:47
- Updated
- 2026-09-13 14:03:47
- Origin id
UNM-CARC/cyverse:docs/index.md
README
# CyVerse User Guide (UNM CARC)
How to use [CyVerse](https://cyverse.org) cyberinfrastructure: accounts, the
Data Store (GoCommands, iCommands, SFTP, WebDAV), the Discovery Environment
and VICE interactive apps, cloud services, and AI tools. Published by the
[UNM Center for Advanced Research Computing (CARC)](https://carc.unm.edu) at
**<https://unm-carc.github.io/cyverse/>**, built with
[Zensical](https://zensical.org), styled after the
[CARC documentation](https://carc.unm.edu/docs/), and structured as an
[Open Knowledge Format (OKF) v0.2](https://github.com/GoogleCloudPlatform/open-knowledge-format)
knowledge bundle so the content is first-class for both humans and AI agents.
The content is adapted from the CyVerse Learning Center user guide
([CyVerse-learning-materials/learning-materials-home](https://github.com/CyVerse-learning-materials/learning-materials-home),
formerly at learning.cyverse.org) under CC BY 4.0 — see [Credits](#credits).
## Quick start
```bash
python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt # zensical + pyyaml (Python 3.11+)
zensical serve # live preview at http://localhost:8000
zensical build --clean # static site in ./site
```
## Repository layout
```
├── zensical.toml # Site configuration (theme, full nav, extensions)
├── docs/ # The OKF knowledge bundle + site content
│ ├── index.md # Landing page (declares okf_version: "0.2")
│ ├── log.md # OKF update log (reserved filename)
│ ├── getting-started/ # What CyVerse is, accounts, subscriptions, help
│ ├── data-store/ # Data Store: DE, GoCommands, iCommands, SFTP, WebDAV
│ ├── discovery-environment/ # Apps, analyses, app integration, vice/ interactive apps
│ ├── cloud/ ai/ # CACAO, DataWatch, Harbor; AI Verde and MCP servers
│ ├── education/ developers/
│ ├── about/ # Credits, contributing, For AI agents
│ ├── llms.txt, llms-full.txt # Generated agent indexes (CI checks drift)
│ ├── assets/ # Images and logos
│ └── stylesheets/extra.css # UNM cherry + turquoise theme
├── scripts/ # OKF validation, link check, llms.txt, agent surface
├── MIGRATION.md # Old learning.cyverse.org URL -> new URL map
├── AGENTS.md / CLAUDE.md # Rules for coding agents working in this repo
└── .github/workflows/docs.yml # Validation + GitHub Pages deployment
```
Every section folder has an `index.md` listing (OKF §8, no frontmatter); every
other page carries OKF frontmatter and must appear in the `nav` of
`zensical.toml`.
## Machine readability (OKF)
Every content page carries YAML frontmatter with:
- `type` — `Guide`, `Tutorial`, `Reference`, or `Policy` (required by OKF)
- `title`, `description`, `tags` — used by search, indexes, and agents
- `generated: { by, at }` — who or what produced the current content
- `sources` — the exact upstream CyVerse file and commit, with `last_modified`
from its git history
- `status` / `stale_after` — lifecycle markers when needed
Pages migrated by an agent are intentionally **unverified** (no `verified`
key). When a reviewer confirms a page, they add
`verified: { by: "human:<netid>", at: "<ISO 8601>" }`.
```bash
python3 scripts/okf_validate.py docs # OKF conformance (CI-enforced)
python3 scripts/check_links.py docs # links, images, nav coverage (CI-enforced)
python3 scripts/gen_llms_txt.py # regenerate llms.txt indexes (CI checks drift)
zensical build --clean && python3 scripts/postbuild_agent_surface.py site
python3 scripts/externalize_links.py # add {target=_blank} to external links
```
The deployed site is directly consumable by AI agents: `/llms.txt` (linked
outline), `/llms-full.txt` (full corpus with frontmatter), a Markdown mirror
at any page URL + `index.md`, `okf:*` meta tags and
`<link rel="alternate" type="text/markdown">` on every page, and a
`robots.txt` that advertises all of it. See `docs/about/ai-agents.md`.
## Credits
Adapted from the CyVerse Learning Center documentation by the CyVerse Science
Team, Copyright © The Arizona Board of Regents (CyVerse), licensed under
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) (see `LICENSE`).
CyVerse is supported by the National Science Foundation (DBI-0735191,
DBI-1265383, DBI-1743442). Each page's `sources` frontmatter and footer link
the original file; `docs/about/credits.md` has the full attribution and
citation guidance, and `MIGRATION.md` maps every old page to its new home.
This adaptation is not endorsed by CyVerse.
## Deployment
Pushing to `main` on [UNM-CARC/cyverse](https://github.com/UNM-CARC/cyverse)
runs OKF validation and the link check, verifies the llms.txt indexes, builds
the site, adds the agent surface, and deploys to GitHub Pages at
<https://unm-carc.github.io/cyverse/> via `.github/workflows/docs.yml`. If the
first deploy fails on permissions, set Settings → Pages → Source to
"GitHub Actions" once.