Skip to main content

PyPI Documentation Status PyPI - License

A Python package to assist in the study of electrokinetic 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 electrokinetic package can be used under the conditions of the GPLv3 license.

Features

  • Basic classes for binary electrolytes.

  • Basic classes for colloidal systems with particles.

  • Basic functions for calculation of ion vibration potential (IVP).

Installation

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

(env) pip install electrokinetic

or

(env) conda install electrokinetic

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

import numpy as np

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

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

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

el = Electrolyte.from_yaml(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

electrokinetic pages

Author and license

References

  • …

Release files for electrokinetic 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for electrokinetic 0.0.3
File Size Uploaded
electrokinetic-0.0.3.tar.gz 746.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for electrokinetic 0.0.3
File Interpreter ABI Platform
electrokinetic-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 1.5 MB

Release files / electrokinetic-0.0.3.tar.gz

Download URL electrokinetic-0.0.3.tar.gz
Size 746.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6185e0c62d9af6b2ce218e6e76083474cb0b50b65395e2e684034997223cdbf1
BLAKE2b-256 checksum
How to use checksums
a1884586c91e5bc80e37f8560f721b64b1e8bb154d5d1c47f220268005204ef6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release files / electrokinetic-0.0.3-py3-none-any.whl

Download URL electrokinetic-0.0.3-py3-none-any.whl
Size 783.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6df3bc36207af1891abd0cc30aea639aee9d09b0468779a28b10d4545b33b7f
BLAKE2b-256 checksum
How to use checksums
17b652177603984d51217bda8c2f56b64a23819fc068545038f349fff541e28e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page