PlanktonIndividuals.jl

PlanktonIndividuals.jl: A GPU supported individual-based phytoplankton life cycle model - Published in JOSS (2022)

https://github.com/juliaocean/planktonindividuals.jl

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

This package simulates the behaviors of an ensemble of phytoplankton individuals.

Basic Info
  • Host: GitHub
  • Owner: JuliaOcean
  • License: mit
  • Language: Julia
  • Default Branch: master
  • Homepage:
  • Size: 1.82 GB
Statistics
  • Stars: 33
  • Watchers: 7
  • Forks: 7
  • Open Issues: 4
  • Releases: 44
Created almost 7 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License

README.md

PlanktonIndividuals.jl

Linux doc doc codecov DOI DOI

animation

PlanktonIndividuals.jl is a fast individual-based model written in Julia that can be run on both CPU and GPU. It simulates the life cycle of phytoplankton cells as Lagrangian particles in the ocean while nutrients are represented as Eulerian, density-based tracers using a 3rd order advection scheme. The model is used to simulate and interpret the temporal and spacial variations of phytoplankton cell densities and stoichiometry as well as growth and division behaviors induced by diel cycle and physical motions ranging from sub-mesoscale to large scale processes.

Installation

To add PlanktonIndividuals.jl to your Julia environment:

julia using Pkg; Pkg.add("PlanktonIndividuals.jl")

Use Examples

1. Simple Flow Fields In Two Dimensions

```julia using PlanktonIndividuals p = dirname(pathof(PlanktonIndividuals))

include(joinpath(p,"../examples/vertical2Dexample.jl"))

include(joinpath(p,"../examples/horizontal2Dexample.jl")) ```

2. Closer Look Into One Grid Box

julia using PlanktonIndividuals p = dirname(pathof(PlanktonIndividuals)) include(joinpath(p,"../examples/0D_experiment.jl"))

3. Turbulent Flow Fields In Three Dimensions

Here Oceananigans.jl is used to generate velocity fields and then use those to drive the individual-based model.

julia using PlanktonIndividuals p = dirname(pathof(PlanktonIndividuals)) include(joinpath(p,"../examples/surface_mixing_3D_example.jl"))

Owner

  • Name: JuliaOcean
  • Login: JuliaOcean
  • Kind: organization

JOSS Publication

PlanktonIndividuals.jl: A GPU supported individual-based phytoplankton life cycle model
Published
May 04, 2022
Volume 7, Issue 73, Page 4207
Authors
Zhen Wu ORCID
Department of Earth, Atmospheric and Planetary Sciences, Massachusetts Institute of Technology
Gael Forget ORCID
Department of Earth, Atmospheric and Planetary Sciences, Massachusetts Institute of Technology
Editor
Jayaram Hariharan ORCID
Tags
Individual-based model Lagrangian particles phytoplankton biogeochemistry GPU support

GitHub Events

Total
  • Create event: 10
  • Commit comment event: 4
  • Release event: 2
  • Watch event: 3
  • Delete event: 6
  • Issue comment event: 2
  • Push event: 46
  • Pull request event: 11
  • Fork event: 2
Last Year
  • Create event: 10
  • Commit comment event: 4
  • Release event: 2
  • Watch event: 3
  • Delete event: 6
  • Issue comment event: 2
  • Push event: 46
  • Pull request event: 11
  • Fork event: 2

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 951
  • Total Committers: 4
  • Avg Commits per committer: 237.75
  • Development Distribution Score (DDS): 0.067
Past Year
  • Commits: 71
  • Committers: 2
  • Avg Commits per committer: 35.5
  • Development Distribution Score (DDS): 0.014
Top Committers
Name Email Commits
zhenwu0728 z****u@m****u 887
gaelforget g****t@m****u 60
Zhen Wu z****u@W****l 2
CompatHelper Julia c****y@j****g 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 12
  • Total pull requests: 76
  • Average time to close issues: 4 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 7.17
  • Average comments per pull request: 0.33
  • Merged pull requests: 68
  • Bot issues: 0
  • Bot pull requests: 9
Past Year
  • Issues: 0
  • Pull requests: 13
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.08
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 4
Top Authors
Issue Authors
  • zhenwu0728 (6)
  • Atreyu-94 (4)
  • JuliaTagBot (1)
  • gaelforget (1)
Pull Request Authors
  • zhenwu0728 (61)
  • gaelforget (20)
  • github-actions[bot] (13)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 4 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 43
juliahub.com: PlanktonIndividuals

This package simulates the behaviors of an ensemble of phytoplankton individuals.

  • Versions: 43
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 4 Total
Rankings
Dependent repos count: 9.9%
Stargazers count: 22.7%
Average: 24.9%
Forks count: 28.1%
Dependent packages count: 38.9%
Last synced: 7 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/doc.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia latest composite
.github/workflows/linux.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg latest composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/setup-julia latest composite