Data

Tools

Indexes

Applications

Experiments

Open Source Science

stratatrapper

Field scale model generation and upscaling toolkit

https://github.com/imperialcollegelondon/stratatrapper

Science Score: 67.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 5 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

capillary-pressure carbon-dioxide co2 co2-storage heterogeneity matlab pflotran porous-media-flow reservoir-simulation upscaling
Last synced: 6 months ago · JSON representation ·

Repository

Field scale model generation and upscaling toolkit

Basic Info
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 1
  • Open Issues: 4
  • Releases: 26
Topics
capillary-pressure carbon-dioxide co2 co2-storage heterogeneity matlab pflotran porous-media-flow reservoir-simulation upscaling
Created about 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

Field scale model generation and upscaling toolkit

Repository: github.com/ImperialCollegeLondon/StrataTrapper

build GitHub Tag GitHub Release Date License DOI

StrataTrapper logo

The StrataTrapper codes

This is the StrataTrapper upscaling toolkit. It can also generate heterogeneous fine-scale models with specific correlation lengths to re-upscale given coarse-scale two-phase flow models.

Another tool is the reduced-physics model CO2GraVISim.

In StrataTrapper-models repository, we publish field-scale models upscaled with StrataTrapper.

Structure

Top-level scripts and functions are in the repository root, and the rest is in src/ folder.

demo.m script is an implementation of the running guideline below.\ Feel free to play with it and use as an example for your own scripts.

Running

  1. Run startup.m to setup MATLAB Path.
    1. Optional: start a parallel pool to run computations there.
  2. Read or generate target coarse grid dimensions and input fine-scale porosity and permeability for each coarse block.
  3. Setup input rock-fluid properties and algorithm options represented by Params and Options classes.
  4. Create logical mask to filter out impermeable cells and/or define an arbitrary subset of cells to process.
  5. Run strata_trapper function with arbitrary number of parallel workers optionally enabling a UI progress bar.
  6. Visualise outputs with plot_result function
  7. Export the outputs to PFLOTRAN-OGS-compatible text files using ogs_export function.

Tips:

  • Usually, MATLAB runs startup.m scripts automatically if they are in a startup folder.
  • The heaviest part of the algorithm is essentially parallel with no synchronisation. So, using several parallel workers usually results in a proportional performance boost.

Versions

The original version of the toolkit is v0.1.0.\ It has its own structure and some unique functionality,\ so it may worth attention as much as later versions.

CHANGELOG.md describes the version history and key changes.

Other versions can be accessed via tags and releases sections of the repository.

Contributing

Everyone is welcome to open issues and pull requests.

References

The StrataTrapper algorithm as well as motivation and theory behind it are in the paper:

Samuel J. Jackson, Samuel Krevor\ Small-Scale Capillary Heterogeneity Linked to Rapid Plume Migration During CO2 Storage\ Geophysical Research Letters | 2020\ https://doi.org/10.1029/2020GL088616

Owner

  • Name: Imperial College London
  • Login: ImperialCollegeLondon
  • Kind: organization
  • Email: icgithub-support@imperial.ac.uk
  • Location: Imperial College London

Imperial College main code repository

Citation (CITATION.cff) 

# https://github.com/citation-file-format/citation-file-format
cff-version: 1.2.0
title: "StrataTrapper upscaling toolkit"
message: >-
  If you use this software,
  please put the copyright NOTICE.txt in your developments
  and cite using CITATION.cff provided in the repository
  or generated by Zenodo
authors:
  - &djmaxus
    family-names: Elizarev
    given-names: Maksim
    alias: djmaxus
    orcid: "https://orcid.org/0000-0002-5279-2877"
    website: "https://djmaxus.dev"
  - family-names: Jackson
    given-names: Samuel J
  - family-names: An
    given-names: Senyou
  - family-names: Wenck
    given-names: Nele
  - family-names: Muggeridge
    given-names: Ann
  - &skrevor
    family-names: Krevor
    given-names: Samuel
doi: "10.5281/zenodo.15438164"
contact:
  - *djmaxus
  - *skrevor
keywords:
  - MATLAB
  - CO2
  - upscaling
  - carbon dioxide
  - heterogeneity
  - reservoir simulation
  - porous media flow
  - pflotran
  - capillary pressure
  - CO2 storage
license: BSD-3-Clause
repository-code: "https://github.com/ImperialCollegeLondon/StrataTrapper"
type: software
url: "https://imperialcollegelondon.github.io/StrataTrapper/"

GitHub Events

Total
  • Create event: 75
  • Release event: 11
  • Issues event: 23
  • Watch event: 8
  • Delete event: 56
  • Issue comment event: 21
  • Push event: 194
  • Pull request review comment event: 13
  • Pull request review event: 55
  • Pull request event: 141
Last Year
  • Create event: 75
  • Release event: 11
  • Issues event: 23
  • Watch event: 8
  • Delete event: 56
  • Issue comment event: 21
  • Push event: 194
  • Pull request review comment event: 13
  • Pull request review event: 55
  • Pull request event: 141

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 4
  • Total pull requests: 122
  • Average time to close issues: 39 minutes
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 1
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.21
  • Merged pull requests: 103
  • Bot issues: 0
  • Bot pull requests: 37
Past Year
  • Issues: 4
  • Pull requests: 122
  • Average time to close issues: 39 minutes
  • Average time to close pull requests: about 8 hours
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.21
  • Merged pull requests: 103
  • Bot issues: 0
  • Bot pull requests: 37
View more stats
Top Authors
Issue Authors
  • djmaxus (11)
Pull Request Authors
  • djmaxus (120)
  • github-actions[bot] (52)
  • dependabot[bot] (12)
  • skrevor (4)
Top Labels
Issue Labels
feature (2) infrastructure (2) documentation (1) bug (1) github_actions (1)
Pull Request Labels
autorelease: pending (39) dependencies (12) autorelease: tagged (11) github_actions (9) feature (6) documentation (2) bug (2)

Dependencies

.github/workflows/webpage.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v4 composite
  • actions/deploy-pages v4 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-pages-artifact v3 composite
.github/workflows/release-please.yml actions
  • google-github-actions/release-please-action v4 composite