News

Feature release

Bug fixes

• Fix filename and density range with dos-local.pdf output
• Fix unintuitive handling of single carrier density and ranges of densities (cardens command line option)
• Fix incorrect verbose output for BHZ parameters B and D
• Silence warnings for numpy.where()
• Eliminate error messages “Some parameters for material (…) did not evaluate to a numerical value” when reading from an XML file

Implementation changes

• Version requirement for Python is raised to 3.11
• Version requirements are raised for imported packages (NumPy, SciPy, etc.)
• Add type annotations in large parts of the source code
• Command line arguments can no longer be parsed twice (with a few exceptions)
• Change the mechanism to set the configuration values in the parallelized computing parts, re-parsing no longer needed
• Refactor implementation of wave function output (plots and tables): minor changes in band labels and file names, restrict output to energy range
• Streamline wave function output in kdotpy 1d: separate run no longer required
• Set number of threads at runtime instead of at import

New features

• Use kdotpy by invoking kdotpy.run() with a list of command line argument in a Python script or the interactive interpreter
• Improve the command line interface: Using --argument or putting -- between the arguments (both optional) prevents misinterpretation of commands
• Parsing information of command line arguments is saved in the XML output file
• Add the command line argument config default to reset the configuration options to their default values
• Material parameter renormalization, in order to deal with spurious solutions
• Add SLEPc as diagonalization solver

Bugfix release

Bug fixes

• Fix XML output for <wflocations> in <modeloptions>
• Make handling of signals (e.g., KeyboardInterrupt) compatible with the new default multiprocessing strategy for Python 3.14 on Linux
• Fix string formatting for Numpy types

Feature release

Bug fixes

• Fix error for BHZ when band character is empty
• Fix incorrect variable name in interpolation function of DiagData
• Fix problem in kdotpy compare trying to update a non-existent figure
• Correct transformation of some BIA terms under an in-plane rotation (kdotpy 1d with stripangle)
• Fix incorrect length of expanded overlap vectors (kdotpy 1d)

Implementation changes

• Restructure source code for parsing command-line arguments
• Remove obsolete imports as to simplify dependencies between submodules
• Reorganize and improve handling of observables
• Reorganize and improve source code for vectors and vector grids
• Improve plot functions
• No longer use columns LL1 and LL2 for transitions in full mode, add an optional column deltaLL

New features

• Calculate derivatives dH/dk and velocities as operators with the currents command-line argument
• Calculate symmetrized observables of the form {dH/dk, O}
• Option to suppress plot output (pdf files) altogether
• Option to save all eigenvalues regardless of the given energy range (set by erange)

Miscellaneous

• Julian Kuther joins the developer team

Feature release

Bug fixes

• Show more instructive error message if a material argument is not followed by a valid material id
• Recalculate or invalidate derivatives if band alignment has changed in kdotpy merge
• Fix exception with checking script directories on different drives in Windows
• Fix exception in kdotpy batch when no variable substitutions are given

Implementation changes

• Improve potential file imports
• Allow y coordinates of spatial lattice to be chosen at integer multiples or at half integer multiples of the resolution
• Save model options into XML output
• Optimize plot handling for 2D band plots

New features

• Apply potentials of the form V(y, z) in kdotpy 1d; accept csv files with grid-type or mesh-type data, and use interpolation if needed
• Optical transitions for bulk Landau level calculations (kdotpy bulk-ll)
• Add filter for material files
• Add helper functions for serialization (for future use)
• Local density of states in multiple dimensions (kdotpy 2d)
• Density as function of y and z (kdotpy 1d)
• Binary output files (Numpy npz format) for local density of states in two dimensions and for density as function of y, z, and energy
• Band alignment in kdotpy 1d (manual only)
• Cache eigenstates with binary files in kdotpy 1d

Miscellaneous

• Add license metadata in pyproject.toml following PEP 639

Unfortunately, the kdotpy website and the Gitlab server encountered an unexpected downtime earlier today, caused by a power outage. At this time, the services are back online. Apologies for the inconvenience.

At the upcoming DPG Spring Meeting (Frühjahrstagung) in Regensburg, we will present several exciting talks about kdotpy and its results:

• Wouter Beugeling et al.
  kdotpy: A Python application for k·p band structure simulations of zincblende semiconductors
  HL12.1, Monday 16:45, room H15

• Maximilian Hofer et al.
  Surface state dominated transport in HgTe topological insulator devices
  HL12.5, Monday 17:45, room H15

• Leonid Bovkun et al.
  Topological Phase Diagram of Mercury Cadmium Telluride Quantum Wells
  HL13.6, Monday 18:00, room H17

  [Read More]

Bugfix release

Bug fixes

• Provide fallback for kdotpy help in case the less command is not available (primarily a Windows issue)
• Fix incorrect quantity being shown in dsigmah-de plot (for kdotpy ll with hall)
• Show more instructive error messages when estimation of CNP fails, for example if the split argument is omitted
• Fix inconsistency between pdf and csv output of wave functions for LL calculations in full LL mode

Feature release

Bug fixes

• Make kdotpy compatible with Numpy 2
• Fix pending deprecations for future Scipy and Python versions

Implementation changes

• Replace hard-coded strain ratio C12/C11 by value from material parameters
• Simplify the implementation for iterators in kdotpy batch
• Make sign of carrier/charge density more consistent internally

New features

• Add elasticity parameters as material parameters
• Add grouped iterators in kdotpy batch, which are iterated through simultaneously
• Enable input of charge density per layer, for simulations of modulation doping

We welcome Julian Kuther as a new contributor. Thanks to Julian for his work on the elasticity parameters!

Our article about kdotpy release 1.0.0 has been offically published by SciPost Physics Codebases! 🎉

Please view the article at https://scipost.org/SciPostPhysCodeb.47.
[DOI: 10.21468/SciPostPhysCodeb.47]

The codebase published with the article can be found at the journal repository. Note that this journal repository will be updated less frequently than our live Gitlab repository.

You are encouraged to credit us by citing the article and/or the codebase, indicating the relevant release/version number.

W. Beugeling, F. Bayer, C. Berger, J. Böttcher, L. Bovkun, C. Fuchs, M. Hofer, S. Shamim, M. Siebert, L.-X. Wang, E. M. Hankiewicz, T. Kießling, H. Buhmann, and L. W. Molenkamp, “kdotpy: k·p theory on a lattice for simulating semiconductor band structures”, SciPost Phys. Codebases 47 (2025).

[Read More]

Bugfix release

Bug fixes

• Fix an incompatibility with matplotlib version 3.10.0, leading to an exception for some DOS plots

Miscellaneous

• Update citation information following publication of our article and codebase in SciPost Physics Codebases