Skip to content

Latest commit

 

History

231 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What is CmmDFT?

CmmDFT is a library developed at the Center for Molecular Modeling (CMM) for the application of classical density functional theory (cDFT) on adsorption and diffusion of gases in nanoporous materials

How to install?

CmmDFT has the following dependencies:

Installation with pip

The easiest way to install CmmDFT is using pip:

pip install .

Or for development installation:

pip install -e .

Installation with conda or mamba

For a conda or mamba-based environment:

mamba create -n CmmDFT python=3.12
mamba activate CmmDFT
python -m pip install -e .

Quick Start with Notebook Tutorials

The best way to get started with CmmDFT is to explore the example notebooks in the examples/ directory:

These notebooks demonstrate end-to-end workflows including system setup, calculations, and result analysis.

Documentation

Documentation can be found at https://molmod.github.io/CmmDFT/.

  • Theory Documentation - Theoretical background on classical DFT
    • Basic cDFT - Introduction to density functional theory
    • Excess Functionals - Details on excess free energy functionals
    • Diffusion Theory - Diffusion calculations
    • Solvers - Numerical solver information
  • API Reference - Complete Python API documentation for all modules

Terms of use

CmmDFT is developed by Vic De Ridder at the Center for Molecular Modeling under supervision of prof. Louis Vanduyfhuys.

Copyright (C) 2019 - 2026 Louis Vanduyfhuys Louis.Vanduyfhuys@UGent.be Center for Molecular Modeling (CMM), Ghent University, Ghent, Belgium; all rights reserved unless otherwise stated.

About

Python code to perform classical DFT simulations

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages