Skip to content
Open
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
_build
.DS_Store
.DS_Store
*.bak
31 changes: 18 additions & 13 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
# Read the Docs configuration file for myst
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# This file was created automatically with `myst init --readthedocs`

# Required
version: 2

# Set the OS, Python version, and Node.js version
# Note: Python is included for executing code in notebooks or using Jupyter Book
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 ./"

python:
install:
- requirements: requirements.txt

sphinx:
builder: html
configuration: _config.yml
fail_on_warning: true
nodejs: "22"
commands:
# Install mystmd
- npm install -g mystmd
# Build the site
- myst build --html
# Copy the output to Read the Docs expected location
- mkdir -p $READTHEDOCS_OUTPUT/html/
- cp -r _build/html/. "$READTHEDOCS_OUTPUT/html"
# Clean up build artifacts
- rm -rf _build
58 changes: 0 additions & 58 deletions _config.yml

This file was deleted.

20 changes: 0 additions & 20 deletions _toc.yml

This file was deleted.

7 changes: 7 additions & 0 deletions content/citation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How to Cite the NSF NGF

If you utilized any of our services in conducting your research, please acknowledge us and our sponsors. This enables us to show the value and impact of the facility.

Work supported by the NSF National Geophysical Facility should acknowledge NSF award 2435260.

For more details, please visit earthscope.org/how-to-cite.
Binary file added content/img/es_user_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 16 additions & 3 deletions content/user_account.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# User Account Creation
# EarthScope User Accounts

Welcome to EarthScope Cloud!

To access most of our data and cloud tools, you will need to register for a FREE user account.
To access most of our data and cloud tools, you will need a FREE user account.
Log in at https://earthscope.org/user

Visit our [EarthScope User Management account page](https://www.earthscope.org/data/authentication/) to sign up and/or view your existing user profile.

# Create an EarthScope Account

To start the registration process, navigate to https://earthscope.org/user . Select "Continue with Google" or "Continue with Cilogon," or if you prefer to use an email and password, click on the "Don't have an account? Sign Up" link instead.

Either option you choose will bring up a page that has several required fields to fill out: First Name, Last Name, Country, Work Sector, and Institution. If you are *not* currently affiliated with a research or educational institution, type "none" in this box and then click "Save".

![image](./img/es_user_create.png)

Finally, click "Register" to complete the process. You may receive an account activation email. Please be aware that this email can take a while to find its way through some institutions' spam filters. Please contact your system administrator or try registering with a different email if you do not receive it and are unable to log in with your new account.

# Credential and License Management
API Access Credentials and real-time GNSS licenses can be managed on your user account page, https://www.earthscope.org/user/info.
31 changes: 31 additions & 0 deletions es_config/earthscope.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Shared configuration file for all EarthScope repositories that feed into docs.earthscope.org

version: 1
project:
open_access: true
license:
content: CC-BY-4.0
code: Apache-2.0

site:
template: book-theme
options:
folders: true
favicon: https://www.earthscope.org/app/uploads/2022/12/cropped-favicon-32x32.png
logo: https://www.earthscope.org/app/uploads/2025/11/NSFNGF-Logo-RGB-Color.svg
logo_dark: https://www.earthscope.org/app/uploads/2025/11/NSFNGF-Logo-RGB-White.svg
logo_url: https://docs.earthscope.org
internal_domains: docs.earthscope.org

nav:
- title: Home
url: https://docs.earthscope.org
- title: GeoLab
url: https://docs.earthscope.org/projects/GeoLab
# open_in_same_tab: true
- title: API
url: https://docs.earthscope.org/projects/API
# open_in_same_tab: true
- title: SDK
url: https://docs.earthscope.org/projects/SDK
# open_in_same_tab: true
16 changes: 6 additions & 10 deletions intro.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
# Welcome to EarthScope's Cloud Data and Developer Documentation Center!

```{Note}
```{note}
This [JupyterBook](https://jupyterbook.org/en/stable/intro.html) is in development as we configure our cloud documentation center.
```

The EarthScope-operated data systems of the NSF GAGE and SAGE Facilities are migrating to cloud services. With this transition comes new capabilities for users to use cloud computing for their own work. Use the links on this page to explore documentation for using our Cloud Data tools and services
The NSF National Geophysical Facility operated by EarthScope Consortium is migrating to the cloud!
With this transition, users have access to new cloud computing capabilities for their own work. Here you can explore documentation for using our Cloud Data tools and services.

The navigation bar across the top links to documentation for EarthScope-operated cloud services. Fundamentals for account creation and getting started are on the left sidebar.

Learn more about EarthScope's Cloud Migration by visiting https://www.earthscope.org/data/cloud/ or by contacting us at: data-help (at) earthscope.org

```{admonition} Projects:
:class: seealso
* GeoLab, EarthScope's JupyterHub: {{ geolab_docs_url }}
<!-- * EarthScope SDK(beta): {{ sdkbeta_docs_url }}
* EarthScope API: {{ api_docs_url }} -->
```
Learn more about EarthScope's Cloud Migration by visiting https://www.earthscope.org/data/cloud/ or by contacting us at: help@earthscope.org
32 changes: 32 additions & 0 deletions myst.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
version: 1
extends:
#TODO: update this to static github url
- ./es_config/earthscope.yml
project:
title: EarthScope Cloud Documentation Center
# authors:
# - name: EarthScope On-Ramp Project Group
copyright: '2024-2026'
github: EarthScope/CloudDocs

toc:
- file: intro.md
# - title: Getting Started
# children:
- file: content/user_account.md
- file: content/citation.md
# - title: EarthScope Cloud Resources
# children:
# - url: https://docs.earthscope.org/projects/GeoLab
# title: GeoLab
# - url: https://docs.earthscope.org/projects/API
# title: EarthScope API
# - url: https://docs.earthscope.org/projects/CLI
# title: EarthScope CLI
# - url: https://docs.earthscope.org/projects/SDK
# title: EarthScope SDK
# site:
# options:
# logo: es_config/logos/cloud_logo_simple_small.png
# folders: true
# template: book-theme