aestimo

Aestimo 1D

A one-dimensional semiconductor heterostructure simulator with Schrödinger–Poisson and drift–diffusion solvers, a command-line interface and a desktop GUI. Aestimo supports educational and scientific calculations of quantum wells and semiconductor devices.

Install

Install the published package in an activated Python environment:

python -m pip install aestimo

The desktop GUI described below is part of the upcoming 4.0.0 release. Until it is published on PyPI, install the preparation source:

python -m pip install "git+https://github.com/aestimosolver/aestimo.git@master"
aestimo --help
aestimo-gui

Python 3.9 or newer is required. The GUI also needs Tk and a graphical desktop. From a downloaded or cloned checkout, use python -m pip install . instead. Installed launch commands require no manual source-directory PATH changes.

Run a calculation

From a source checkout:

aestimo -i examples/sample_1qw_barrierdope_ingaas.py

Add -d to display plots. The CLI accepts Python inputs and GUI JSON projects; results are written to <input-stem>_output/ in the current working directory.

Installed GUI presets and reference CSVs are copied to ~/Aestimo/examples on first launch without overwriting existing user files. Set AESTIMO_WORKSPACE to choose a different workspace root. A checkout uses its own examples/.

Documentation

Read the Aestimo documentation for installation, calculations and project information. The guide source is maintained in docs/.

• About and citation
• Models and materials
• Installation
• Your first calculation
• CLI quick start
• GUI workflow
• Inputs and units
• Outputs
• Tutorials
• Troubleshooting
• Authors and contributors
• Release notes
• Publications
• Development
• Validation and reference-data status

The source version is recorded in pyproject.toml. Preset names, plot labels and passing regression tests do not independently certify experimental accuracy.

Support and license

Report bugs or ask questions through GitHub issues.

Aestimo is distributed under the GNU GPL v3 or later; see COPYING.md. The project was initiated by Sefer Bora Lisesivdin, with major contributions from Robert J. Steed, Hamza Hebal and other contributors.