carbocatlite

CarboCATLite model by Peter Burgess

https://github.com/mindthegap-erc/carbocatlite

Science Score: 57.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary

Keywords

carbonate carbonate-platform carbonate-sedimentology cellular-automata forward-model geological-models geology sedimentology
Last synced: 6 months ago · JSON representation ·

Repository

CarboCATLite model by Peter Burgess

Basic Info
  • Host: GitHub
  • Owner: MindTheGap-ERC
  • License: apache-2.0
  • Language: MATLAB
  • Default Branch: main
  • Homepage:
  • Size: 49.5 MB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 4
  • Releases: 2
Topics
carbonate carbonate-platform carbonate-sedimentology cellular-automata forward-model geological-models geology sedimentology
Created almost 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

CarboCAT Lite

CarboCATLite is a reduced complexity version of the CarboCAT model of carbonate platform growth developed by Peter Burgess, see Burgess (2013). CarboCATLite uses a cellular automata to model spatial competition between carbonate factories whose accumulation rates are dependent on environmental conditions (e.g., subsidence and sea level driven water depth, wave energy, etc.).

Running Instruction

GUI

  1. In Matlab, run the command

{matlab} run carboCATGUI

This will open the CarboCATLite GUI

  1. Click the "initialize" button. This will import the model parameters from the params folder
  2. Click the "Run CA model" button to run the model. The model status is shown in the console. The run is finished if you see the message

{matlab} Model complete after X iterations and ready to plot

in the console.

  1. After the run is finished, all model outputs are in the matlab workspace, and are saved into the file CarboCATLiteoutputs.mat_.

  2. To plot the results, click "plot run". This will generate the chronostratigraphic diagram and a basin transect in dip direction. Both the initial conditios and the chronostrat diagram/basin transect are automatically saved as .pdf files. WARNING: Generating the plots can take a long time. Saving the plots is finished once the message figure saved is displayed in the console.

CLI

  1. In Matlab, run the command

{matlab} CarboCAT_cli("params/DbPlatform/paramsInputValues.txt", "params/DbPlatform/paramsProcesses.txt", "model_run_42", "params/DbPlatform/seaLevelConst3000iterations.txt", true)

Input parameters:

ParamsPath: string, relative path to the file with parameters, e.g. "params/DbPlatform/paramsInputValues.txt"

ProcessPath: string, relative path to the file with the process settings, e.g. "params/DbPlatform/paramsProcesses.txt"

OutputName: string, name to which model outputs are saved, e.g. "modelrun42"

SeaLevelPath: string, relative path to the file with the sea level curve, e.g. "params/DbPlatform/seaLevelConst3000iterations.txt"

makePlot: logical, true or false. Should the chronostratigraphic plot be generated?

  1. After the run is finished, all model outputs are saved into the file given as OutputName. This file can be further analyzed using scripts in the repo MindTheGap-ERC/CarboCAT_utils.

License and copyright

Copyright for the original code (1.0.0) 2013-2023 University of Liverpool and Royal Holloway, University of London Copyright modifications proposed here: 2023-2024 Utrecht University, the Netherlands eScience Center and University of Liverpool

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

References

Burgess, Peter M. "CarboCAT: A cellular automata model of heterogeneous carbonate strata." Computers & geosciences 53 (2013): 129-140.

Owner

  • Name: MindTheGap-ERC
  • Login: MindTheGap-ERC
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CarboCAT Lite
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Peter
    family-names: Burgess
    email: pmb42@liverpool.ac.uk
    affiliation: University of Liverpool
    orcid: 'https://orcid.org/0000-0002-3812-4231'
identifiers:
  - type: url
    value: 'https://github.com/MindTheGap-ERC/CarboCATLite'
keywords:
  - sedimentology
  - cellular automata
  - carbonate
  - forward model
license: Apache-2.0

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 43
  • Total Committers: 4
  • Avg Commits per committer: 10.75
  • Development Distribution Score (DDS): 0.535
Past Year
  • Commits: 27
  • Committers: 4
  • Avg Commits per committer: 6.75
  • Development Distribution Score (DDS): 0.704
Top Committers
Name Email Commits
Niklas Hohmann 6****n 20
Bukoplot e****a@u****l 10
Hohmann n****n@u****l 8
xyl96 6****6 5
Committer Domains (Top 20 + Academic)
uu.nl: 2

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 7
  • Total pull requests: 1
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: 20 days
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 1.43
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 1
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: 20 days
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 1.43
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • EmiliaJarochowska (7)
  • NiklasHohmann (1)
Pull Request Authors
  • EmiliaJarochowska (2)
Top Labels
Issue Labels
Pull Request Labels