ErwinJr2 2.2.7

Description:

ErwinJr2 2.2.7

A software for Quantum Cascade Laser design and simulation




dev:


This is a Quantum Cascade Laser (QCL) modeling and design software produced
at Princeton University, Gmachl group.
See https://erwinjr2.readthedocs.io/ for details.

In the following a simple installation guide is included. A more comprehensive
documents can be found here
Installation
The software is based on Python (>=3.9) and uses setuptools for installation.
The easiest way to install the software is via pip the Python package manager.
Fist to make sure you have the latest pip installed (depending on your
environment, python maybe python3):
python -m pip install pip --upgrade

Than install ErwinJr2 by:
python -m pip install ErwinJr2

Now you can start the software via
ErwinJr

or if you want to, you can create a shortcut on the desktop via
ErwinJr-genshortcut

For reasonably new versions of Windows, MacOS with x86_64 CPU or Linux this
should work out of box. For other platform the compiled library may not work,
you may see C library is not compiled. Features are limited. warning if
that happens. In that case, refer to
The Documents
for more detail about how to install it from source code and compile the
library locally.
TODO list

OpenMP support
Add a linear algebra solver
?NEGF solver
upload to pip
register to OS
remove unnecessary C lib
Add IFR scattering
Add impurity scattering (may be important for transport)
Add finite temperature (to improve population distribution)
Add gain spectrum
global optimizer for QCLayers
optimizer for optical stratum
save to excel (to growth sheet)
Test case improve:

LO and IFR scattering results
Consistency with and without C lib
Electron population check


Documents

make type hint consistent


GUI indication of running computation
EJcanvas.config to qt setting
plot style to global settings
Profile
Travis CI automatic testing
upload to pip as a library
?coveralls.io
?codacy
?CFFI or SWIG
Provide binary