Fluid Earth

About

Fluid Earth is developed and maintained by The Ohio State University's Byrd Polar and Climate Research Center.

If you are interested in using Fluid Earth for educational purposes or collaborating with us to develop Fluid Earth for a specific application, please email gravina.2@osu.edu.

For more information, visit the Help & About menu at Fluid Earth.

Development

Frontend-only setup

Prerequisites

• git
• Node.js
• pnpm

git clone https://github.com/byrd-polar/fluid-earth
cd fluid-earth
pnpm install
pnpm run dev

Changes to files in src will be automatically displayed from the dev server.

Local backend setup

Additional prerequisites

• wgrib
• wgrib2
• NetCDF
• Deno

First, complete the frontend-only setup.

Then, create an account to access CDS. Once logged in, accept the Copernicus license and use your CDS API key to create a .env file in the root of this Git repository with the following content, replacing the Xs with your key:

CDS_API_KEY=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Similarly, create an account to access Earthdata, and add your username and password to .env:

EARTHDATA_LOGIN=username:password

Finally, in a separate terminal tab/window:

pnpm run tera

To develop against the remote backend again (as in the frontend-only setup), remove the public/tera directory.

Building frontend for production

pnpm run build
pnpm run preview

Updating local development environment

git pull https://github.com/byrd-polar/fluid-earth
pnpm install

Web component

Fluid Earth comes with a lightweight web component which can be included in webpage contexts where the full application is not needed. Refer to the documentation for more info on using the web component.