georuleslobepy

Deep-water lobe simulator using rule-based models, Markov chains, and geological knowledge.

https://github.com/chaconnb/georuleslobepy

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 2 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 (11.9%) to scientific vocabulary

Keywords

geology-modelling markov-chain reservoir-computing

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation ·

Repository

Deep-water lobe simulator using rule-based models, Markov chains, and geological knowledge.

Basic Info
  • Host: GitHub
  • Owner: chaconnb
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 24.2 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 2
Topics
geology-modelling markov-chain reservoir-computing
Created about 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

GeorulesLobePy

DOI

To run the main code run: 1. Activate the georuleslobepy environment bash conda activate georuleslobepy 2. Run the main notebook: bash notebooks/Results_Visualizations.ipynb 3. Run the main: bash main.py

Developer Quick Start

GeorulesLobePy uses Conda to manage the Python environment. External libraries are installed using PIP. Please refer to the Conda documentation.
- Managing Conda environments - Conda installation guide

Installation

To set up the environment from scratch and install the package along with all required dependencies, follow these steps:

```bash

run these commands in the project root

Step 1: Create a new conda environment with Python 3.11

conda create -n georuleslobepy python=3.11

Step 2: Activate the environment

conda activate georuleslobepy

Step 3: Install the package in editable mode (installs all dependencies listed in pyproject.toml)

pip install -e . `` This will: - Install thegeoruleslobepy` package in editable mode, allowing you to modify the code without reinstallation - Install all necessary dependencies (including support for Jupyter notebooks and interactive PyVista plotting)

WARNING: If the dependencies listed in pyproject.toml change (e.g., new packages are added or versions updated), it is recommended to rebuild the environment from scratch to ensure consistency.

To delete the existing georuleslobepy environment run: bash conda remove --name georuleslobepy --all # remove georuleslobepy env

Acknowledgments

Special thanks to Dr. Daniel Willhelm for help with code refactoring.

Owner

  • Name: Nataly Chacon-Buitrago
  • Login: chaconnb
  • Kind: user
  • Location: Austin
  • Company: UT Austin

Hi, I am Nataly! I am a geostatistics Ph.D. student at UT Austin!

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Chacon-Buitrago"
    given-names: "Nataly"
    orcid: "https://orcid.org/0009-0003-0124-9182"
  - family-names: "Willhelm"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0002-9365-0744"
title: "GeoRulesLobePy"
version: 0.1.1
identifiers:
  - type: doi
    value: 10.5281/zenodo.15717350
date-released: 2025-06-22

GitHub Events

Total
  • Push event: 5
  • Pull request event: 1
  • Create event: 1
Last Year
  • Push event: 5
  • Pull request event: 1
  • Create event: 1

Dependencies

pyproject.toml pypi
  • ipykernel *
  • ipywidgets *
  • jupyterlab >=3
  • matplotlib *
  • numpy *
  • pyvista [all,trame]==0.45.2
  • scipy *