Welcome to the EduMUD documentation pages!

Contents

EduMUD

PyPI Documentation Status PyPI - License

A Python package to assist in the study of sedimentation phenomena in colloidal suspensions. The code is being developed by Paul J.M. van Kan for the MUDNET group at Delft Technical University and DELTARES, The Netherlands. The EduMUD package can be used under the conditions of the GPLv3 license.

Features

  • Basic classes colloidal systems

  • Basic functions for DLVO theory.

Installation

To use the package edumud, install it in a Python environment:

(env) pip install edumud

or

(env) conda install edumud

This should automatically install the dependency packages matplotlib , scipy and pandas, if they haven’t been installed already. If you are installing by hand, ensure that these packages are installed as well.

Example use

"""Example Python script using the EduMUD module."""

import numpy as np

from edumud.constants import *
from edumud.electrolytes import Electrolyte
from edumud.particles import Particle
from edumud.file_utils import load_config

import matplotlib
import matplotlib.pyplot as plt
from pathlib import Path

matplotlib.use("Qt5Agg")
DATADIR = Path(__file__).parent

el = Electrolyte(str(DATADIR / "cegm.yaml"))
el.calc_kappa()

param = load_config(str(DATADIR / "cegm.yaml"))
part = Particle.from_dict(param["particles"][0])

zeta_zero = BOLTZ_T / (el.z_plus * E_CHARGE)
print(f"zeta_zero: {1000 * zeta_zero} mV")
psi_zero = 0.5 * zeta_zero

EduMUD pages

Author and license

References

  • …