Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 3.18 KB

README.md

File metadata and controls

71 lines (50 loc) · 3.18 KB
Raw

Welcome to ParticleViz

ParticleViz is an Open Source software that is used to animate large number of particles inside dynamic web maps. It is designed mostly for Earth Science scientists that simulate different processes using Lagrangian models.

The objectives of this software are:

  • Provide efficient visualizations that can help analyze and understand research made through lagrangian modelling in the Earth Sciences, in a fast and easy way.
  • Make it easy to share this research with other colleagues with self-contained websites.

ParticleViz currently reads NetCDF outputs from OceanParcels and OpenDrift.

Status

GitHub Repo stars GitHub GitHub all releases GitHub issues GitHub commit activity

Install

  1. Clone the repository.
git clone https://github.com/olmozavala/particleviz.git
cd particleviz
  1. Create a conda environment with the proper dependencies. For this step, you first need to install Anaconda (or Miniconda), more details can be found here.
conda env create -f particleviz.yml
conda activate particleviz
  1. Enjoy life

Quick Start

The simplest way to use ParticleViz is to run it specifying the input netcdf from the command line directly (NetCDF should follow OceanParcels or OpenDrift format).

python ParticleViz.py --input_file <path_to_netcdf>

This will generate the default web interface and store the parameters into a configuration file, Current_Config.json. It can be edited to customize the interface. You need to be patient the first time you run it because it will install all the Javascript dependencies.

Test it with the Global_Marine_Debris.nc example file in the ExampleData folder:

python ParticleViz.py --input_file ExampleData/Global_Marine_Debris.nc

example

Docker

You can run ParticleViz as a docker container. By default it will run using the example netcdf files. If you want to change it, edit entrypoint.sh to point to a file inside the particleviz folder.

  1. Install Docker
  2. git clone https://github.com/olmozavala/particleviz.git
  3. cd particleviz
  4. docker build --pull --rm -f Dockerfile -t particleviz "."
  5. docker run --rm -it -p 3000:3000 particleviz:latest
  6. http://localhost:3000/

Intro video

This is a presentation made at OceanSciences meeting about ParticleViz in March 2022.

ParticleViz at OSM

Docs

Please take a look at the complete docs at https://olmozavala.github.io/particleviz/