https://github.com/byrd-polar/fluid-earth
Fluid Earth is a WebGL-powered visualization of Earth's atmosphere and oceans
https://github.com/byrd-polar/fluid-earth
atmosphere byrd earth fever oceans ohio-state-university webgl webgl2
Last synced: 5 months ago
JSON representation
Fluid Earth is a WebGL-powered visualization of Earth's atmosphere and oceans
- Host: GitHub
- URL: https://github.com/byrd-polar/fluid-earth
- Owner: byrd-polar
- License: mit
- Created: 2020-07-14T14:25:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T18:04:15.000Z (7 months ago)
- Last Synced: 2024-10-29T19:52:54.359Z (6 months ago)
- Topics: atmosphere, byrd, earth, fever, oceans, ohio-state-university, webgl, webgl2
- Language: JavaScript
- Homepage: https://fluid-earth.byrd.osu.edu
- Size: 7.52 MB
- Stars: 117
- Watchers: 3
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - Fluid Earth - Open-source Visualization of Weather and Climate Data. (Climate Change / Climate Data Access and Visualization)
README
# Fluid Earth
[](https://fluid-earth.byrd.osu.edu/#gdata=wind+speed+at+500+mb&pdata=wind+at+500+mb&smode=false)
## 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 [[email protected]](mailto:[email protected]).
For more information, visit the Help & About menu at
[Fluid Earth](https://fluid-earth.byrd.osu.edu/).
## Development
### Frontend-only setup
#### Prerequisites
- [git](https://git-scm.com/)
- [Node.js](https://nodejs.org)
- [pnpm](https://pnpm.io/installation#using-corepack)
```sh
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](https://www.cpc.ncep.noaa.gov/products/wesley/wgrib.html)
- [wgrib2](https://www.cpc.ncep.noaa.gov/products/wesley/wgrib2/)
- [NetCDF](https://www.unidata.ucar.edu/downloads/netcdf/)
- [Deno](https://deno.land/#installation)
First, complete the frontend-only setup.
Then, [create an account](https://cds.climate.copernicus.eu/) to
access CDS. Once logged in, [accept the Copernicus license](https://cds.climate.copernicus.eu/datasets/reanalysis-era5-single-levels-monthly-means?tab=download)
and use your [CDS API key](https://cds.climate.copernicus.eu/how-to-api) to
create a `.env` file in the root of this Git repository with the following
content, replacing the `X`s with your key:
```env
CDS_API_KEY=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
```
Similarly, [create an account](https://urs.earthdata.nasa.gov/users/new) to
access Earthdata, and add your username and password to `.env`:
```env
EARTHDATA_LOGIN=username:password
```
Finally, in a separate terminal tab/window:
```sh
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
```sh
pnpm run build
pnpm run preview
```
### Updating local development environment
```sh
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](webcomponent/README.md) for more info on using the
web component.