Git Product home page Git Product logo

pybarsim's Introduction

pyBarSim

DOI:10.4121/60f148ee-a793-4d16-b1b6-c03442403db1.v1 Binder

pyBarSim is a Python package to simulate wave-dominated shallow-marine environments using Storms (2003)'s BarSim.

Installation

You can directly install pyBarSim from pip:

pip install pybarsim

Or from GitHub using pip:

pip install git+https://github.com/grongier/pybarsim.git

Usage

Basic use:

import numpy as np
from pybarsim import BarSim2D
import matplotlib.pyplot as plt

# Set the parameters
run_time = 10000.
barsim = BarSim2D(np.linspace(1000., 900., 200),
                  np.array([(0., 950.), (run_time, 998.)]),
                  np.array([(0., 25.), (run_time, 5.)]),
                  spacing=100.)
# Run the simulation
barsim.run(run_time=10000., dt_fair_weather=15., dt_storm=1.)
# Interpolate the outputs into a regular grid
barsim.regrid(900., 1000., 0.5)
# Compute the mean grain size
barsim.finalize(on='record')
# Plot the median grid size in the regular grid
barsim.record_['Mean grain size'].plot(figsize=(12, 4))
plt.show()

For a more complete example, see the Jupyter notebook using_pybarsim.ipynb or the Binder link above.

Citation

If you use pyBarSim in your research, please cite the original article:

Storms, J.E.A. (2003). Event-based stratigraphic simulation of wave-dominated shallow-marine environments. Marine Geology, 199(1), 83-100. doi:10.1016/S0025-3227(03)00144-0

Here is the corresponding BibTex entry if you use LaTex:

@Article{Storms2003,
	author="Storms, Joep E.A.",
	title="Event-based stratigraphic simulation of wave-dominated shallow-marine environments",
	journal="Marine Geology",
	year="2003",
	volume="199",
	number="1",
	pages="83--100",
	issn="0025-3227",
	doi="https://doi.org/10.1016/S0025-3227(03)00144-0",
}

Credits

This software was written by:

Guillaume Rongier
ORCID Badge
Joep Storms
ORCID Badge
Andrea Cuesta Cano
ORCID Badge

License

Copyright notice: Technische Universiteit Delft hereby disclaims all copyright interest in the program pyBarSim written by the Author(s). Prof. Dr. Ir. J.D. Jansen, Dean of the Faculty of Civil Engineering and Geosciences

© 2023, G. Rongier, J.E.A. Storms, A. Cuesta Cano

This work is licensed under a MIT OSS licence.

pybarsim's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.