Skip to content

About

A MATLAB GUI toolbox for running KSSOLV-based density functional theory calculations, covering structure import, calculation setup, workflow management, and post-analysis.

Topics

Resources

Code of conduct

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Latest commit

 

History

280 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KSSOLV Toolbox

Github Release Version License: BUSL-1.1 GitHub top language MATLAB Versions Tested MathWorks Connections Program

KSSOLV Toolbox is a MATLAB-based graphical tool designed to make running density functional theory (DFT) calculations provided by the Kohn-Sham Solver (KSSOLV) package easier and more intuitive. It helps researchers avoid writing complex scripts and instead complete the full workflow—from structure import and calculation setup to post-analysis—through a user-friendly interface.

KSSOLV Toolbox crystal modeling workspace

KSSOLV Toolbox GUI

Key Features

KSSOLV Toolbox brings structure preparation, workflow execution, and result analysis into a single project-based workspace:

  • Interactive materials modeling: Build and edit molecules, crystals, surfaces, interfaces, defects, polymers, and amorphous structures in a 3D workspace with previews, measurements, and undoable operations.
  • Workflow-driven DFT calculations: Configure and connect calculation tasks, including SCF and Non-SCF workflows, without assembling a collection of standalone MATLAB scripts.
  • Scientific visualization and analysis: Inspect atomic structures, band structures, and CHGCAR, Cube, or XSF scalar fields using isosurfaces, lattice-aligned slices, direct volume rendering, and export tools.
  • Flexible local and remote execution: Run calculations locally or use supported MATLAB Parallel Server, Slurm, remote MATLAB, and cluster-profile configurations while tracking jobs and importing completed results.
  • Reproducible modeling and automation: Record and replay modeling operations, run batch preparation tasks, and use versioned MATLAB APIs for scripted workflows.

Workflow compute resources

Choose serial execution or a supported parallel environment in each node's configuration. SCF, NSCF, Band Calculation, Band Calculation 3D, and DOS support GPU diagonalization with lobpcg, davidson, davidson2, and davpcg. Other methods do not offer GPU execution. GPU kernel threads are device managed. NSCF, band, and DOS nodes also configure process pools with limits on workers and CPU computational threads per worker. HT interpolation disables these unused parallel paths; Band Calculation 3D calls NSCF directly and ignores the HT flag. Other nodes offer serial execution only; thread-worker pools are not enabled.

The NSCF node stores parameters and resources; band and DOS nodes perform the calculations. New calculation nodes default to Use NSCF settings. They can also explicitly select serial, process-pool, or GPU execution; serial and process execution clear any inherited GPU flag. Existing workflows retain their saved serial choices; select inheritance explicitly when needed. Process pools are created and bounded when the calculation actually runs.

Resource choices are saved with workflows and included in remote submissions. Parallel execution requires Parallel Computing Toolbox on the execution machine; GPU execution also requires a supported GPU. An existing pool that exceeds a node's limits causes an explicit error. Remote batch jobs must allocate a pool that fits those limits. After completion or failure, Toolbox closes pools it created and restores the previous CPU thread setting.

Installation

KSSOLV Toolbox requires MATLAB® R2025a or later when used in the MATLAB desktop environment. It also provides a standalone application version that can be deployed on Windows, macOS, and Linux platforms.

For installation, usage, and feature guides, see the User Documentation.

Contributing

🎯 Contributions via Issues and PRs are welcome!

  • New feature? Please open an Issue describing the request. After discussion and confirmation, you may submit a PR.
  • Bug fix? You may directly submit a PR—just include a clear description of the issue and your fix.

By submitting code, documentation, or any other contribution to this project, the contributor represents that they have the right to submit it and, to the fullest extent permitted by law, automatically and unconditionally assigns to the KSSOLV Toolbox Development Team (the Rights Holder), on a perpetual, irrevocable, worldwide, and royalty-free basis, all transferable economic copyrights and related rights in the contribution. To the extent that any such right cannot legally be assigned, or the assignment is ineffective, the contributor grants the Rights Holder a perpetual, irrevocable, worldwide, royalty-free, transferable, and fully sublicensable license to use, reproduce, modify, adapt, publish, distribute, and relicense the contribution under any terms, including BUSL-1.1, the Change License, and commercial licenses. Submission of a contribution constitutes acceptance of these terms.

License

The original portions of KSSOLV Toolbox are available under the Business Source License 1.1 (BUSL-1.1):

  • Non-production use is permitted under BUSL-1.1.
  • Production use is permitted for teaching and education, qualifying academic or personal research, and qualifying charitable or nonprofit activities, as specified in the Additional Use Grant.
  • Other production use, including commercial research and development, requires a separate commercial license.
  • On July 22, 2030, or the fourth anniversary of a version's first public distribution under BUSL-1.1, whichever comes first, that version will become available under GNU GPL v3.0 or later.

BUSL-1.1 is a source-available license and is not an Open Source license before the applicable Change Date. Third-party components remain under their respective licenses; see Third-Party Licenses. Releases distributed before this license change remain subject to the licenses that accompanied those releases.

Citation

If you use KSSOLV Toolbox in your research or publications, please cite the following work.

@article{YangLiu_KSSOLV_Toolbox_2026,
  author = {Yang, Liu and Yang, Jinlong and Hu, Wei},
  title = {KSSOLV Toolbox: A MATLAB Graphical User Interface for Plane-Wave Density Functional Theory Calculations},
  journal = {Journal of Chemical Theory and Computation},
  volume = {22},
  number = {11},
  pages = {5579--5593},
  year = {2026},
  doi = {10.1021/acs.jctc.6c00523},
  note = {PMID: 42175909},
  url = {https://doi.org/10.1021/acs.jctc.6c00523},
  eprint = {https://doi.org/10.1021/acs.jctc.6c00523}
}

MathWorks Connections Program

About

A MATLAB GUI toolbox for running KSSOLV-based density functional theory calculations, covering structure import, calculation setup, workflow management, and post-analysis.

Topics

Resources

Code of conduct

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages