gadget3

TMB-based gadget implemtation

https://github.com/gadget-framework/gadget3

Science Score: 26.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
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary

Last synced: 9 months ago · JSON representation

Repository

TMB-based gadget implemtation

Basic Info

Host: GitHub
Owner: gadget-framework
License: gpl-2.0
Language: R
Default Branch: master
Homepage:
Size: 10.1 MB

Statistics

Stars: 8
Watchers: 5
Forks: 5
Open Issues: 48
Releases: 0

Created over 6 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog License

README.md

Gadget3: Globally applicable Area Disaggregated General Ecosystem Toolbox v3

Gadget3 is a framework for producing marine ecosystem models. Gadget3 creates a R or TMB objective function for you, that can then be optimised with standard tools such as nlminb().

Gadget3 is primarily designed to produce models matching the behaviour of gadget2, although implementing new modelling systems would be possible

This package is part of suite of tools, including:

gadgetutils: Simplify common steps when setting up a gadget3 model
gadgetplots: Plot output from a gadget3 model
gadget2to3: Convert gadget2 model configuration to gadget3
mfdb: Marine ecosystem data management tool

Installation

gadget3 is available on CRAN:

> install.packages('gadget3')

You can also install the latest development version from github:

> remotes::install_github('gadget-framework/gadget3')

Documentation

The gadget3 documentation is published online. To get started, read the introductory vignette, which walks through the process of building a model.

For some real-life examples of gadget3 models, look in the gadget-models repository:

Development of gadget3

The documentation for the latest development version is published online.

You can install it with:

r remotes::install_github("gadget-framework/gadget3")

Tests can be run with R CMD check. By default, tests are only run against the R backend for speed. To run against the TMB backend, set the G3_TEST_TMB environment variable, with one of:

Sys.setenv(G3_TEST_TMB = 1) ; source('tests/test-action_grow.R')
make, which runs both test & integration tests with G3TESTTMB
make test G3_TEST_TMB="2", which runs all TMB tests

Releases are made with:

make release NEW_VERSION=0.9-0
git push --tags && git push

On success, upload the tarball to https://cran.r-project.org/submit.html

Acknowledgements

Gadget3 has received funding from:

Innviðasjóður Icelandic infrastructure grant #191774-0031
Under One Cod #206740-051
Fishing into the Future, Rannís grant of excellence #206967-051
NORSUSTAIN project funded by the joint Danish, Greenlandic, and Faroese Presidency of the Nordic Council of Ministers
Formas Swedish Research Council for Sustainable Development #2021-00826

Owner

Name: gadget-framework
Login: gadget-framework
Kind: organization

Repositories: 14
Profile: https://github.com/gadget-framework

GitHub Events

Total

Issues event: 25
Delete event: 18
Issue comment event: 93
Push event: 142
Pull request event: 44
Create event: 21

Last Year

Issues event: 25
Delete event: 18
Issue comment event: 93
Push event: 142
Pull request event: 44
Create event: 21

Issues and Pull Requests

Last synced: 9 months ago

All Time

Total issues: 161
Total pull requests: 111
Average time to close issues: 6 months
Average time to close pull requests: 10 days
Total issue authors: 7
Total pull request authors: 4
Average comments per issue: 3.26
Average comments per pull request: 0.86
Merged pull requests: 97
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 21
Pull requests: 66
Average time to close issues: 9 days
Average time to close pull requests: 4 days
Issue authors: 3
Pull request authors: 1
Average comments per issue: 2.19
Average comments per pull request: 0.5
Merged pull requests: 56
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

lentinj (122)
vbartolino (13)
bthe (11)
MikkoVihtakari (7)
willbutler42 (5)
mmrinconh (2)
pfrater (1)

Pull Request Authors

lentinj (99)
willbutler42 (10)
MikkoVihtakari (1)
pfrater (1)

Top Labels

Issue Labels

low-priority (9) core-g3 (8) gadget2-feature-parity (5) CRAN blocker (1) bug (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 453 last-month

Total dependent packages: 0
Total dependent repositories: 2
Total versions: 6
Total maintainers: 1

cran.r-project.org: gadget3

Globally-Applicable Area Disaggregated General Ecosystem Toolbox V3

Homepage: https://gadget-framework.github.io/gadget3/
Documentation: http://cran.r-project.org/web/packages/gadget3/gadget3.pdf
License: GPL-2
Latest release: 0.13-0
published about 1 year ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 2
Downloads: 453 Last month

Rankings

Forks count: 10.8%

Stargazers count: 18.3%

Dependent repos count: 19.2%

Average: 27.6%

Dependent packages count: 28.7%

Downloads: 61.1%

Maintainers (1)

lentinj@shuttlethread.com