ErwinJr2

https://erwinjr2.readthedocs.io/en/stable/
Admin
ErwinJr2 is a cross-platform software tool for modeling quantum problems in 1D semiconductor...
Tokens:63,125
Snippets:257
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install on Linux with setup.py

Source: https://erwinjr2.readthedocs.io/en/stable/manual/install.html

Install the software from the code directory on Linux. Add --user to install in the user directory if you lack full system control.

```bash
python setup.py install

```

--------------------------------

### Install ErwinJr2 with pip and run it

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/manual/install.rst.txt

Install ErwinJr2 with pip, then start it with the ErwinJr command or create a desktop shortcut with ErwinJr-genshortcut. Requires Python and pip. If the compiled library is not available, you may see 'C library is not compiled. Features are limited.' when starting from the command line.

```bash
python -m pip install pip --upgrade
```

```bash
python -m pip install ErwinJr2
```

```bash
ErwinJr
```

```bash
ErwinJr-genshortcut
```

--------------------------------

### Install setuptools, wheel, and PyQt5

Source: https://erwinjr2.readthedocs.io/en/stable/manual/install.html

Upgrade setuptools and wheel, then install PyQt5 for GUI support. Required for development or if not on a remote server.

```bash
python -m pip install setuptools, wheel --upgrade

```

```bash
python -m pip install pyqt5

```

--------------------------------

### Install ErwinJr2 on Linux with setup.py

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/manual/install.rst.txt

Install ErwinJr2 on Linux from the source directory. Add --user at the end to install in the user directory if you don't have full control of the system.

```bash
python setup.py install
```

--------------------------------

### Prepare environment with setuptools and PyQt5

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/manual/install.rst.txt

Prepare the environment for building ErwinJr2 from source: upgrade setuptools and wheel, and optionally install PyQt5 for GUI support. The software uses setuptools for installation.

```bash
python -m pip install setuptools, wheel --upgrade
```

```bash
python -m pip install pyqt5
```

--------------------------------

### Set MSBUILD and install on Windows

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/manual/install.rst.txt

On Windows, set the MSBUILD environment variable to the Visual Studio MSBuild.exe path, then run python setup.py install to compile with Visual Studio. The path depends on your Visual Studio installation.

```bash
set MSBUILD=C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\MSBuild.exe
```

```bash
python setup.py install
```

--------------------------------

### PQLiu.json sample data file

Source: https://erwinjr2.readthedocs.io/en/stable/Profiling.html

Sample ErwinJr2 data file used in the profiling example. Contains QCLayers and Waveguide definitions with material properties, doping, and custom active core settings.

```json
{
    "FileType": "ErwinJr2 Data File",
    "Version": "210330",
    "Description": "dx.doi.org/10.1038/nphoton.2009.262",
    "QCLayers": {
        "Wavelength": 4.7,
        "Substrate": "InP",
        "EField": 102.0,
        "x resolution": 1.0,
        "E resolution": 0.5,
        "No of states": 20,
        "Solver": "ODE",
        "Temperature": 300.0,
        "Repeats": 4,
        "MaterialDefs": {
            "Compostion": ["InGaAs", "AlInAs"],
            "Mole Fraction": [0.66, 0.31]
        },
        "Material": [1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0],
        "Width": [23.0, 28.0, 26.0, 22.0, 21.0, 18.0, 18.0, 15.0, 13.0, 12.0, 10.0, 42.0, 12.0, 39.0, 14.0, 33.0],
        "Doping": [0.0, 0.0, 1.5, 1.5, 1.5, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
        "Active Region": [false, false, false, false, false, false, false, true, true, true, true, true, true, true, true, true],
        "IFR": false
    },
    "Waveguide": {
        "wavelength": 4.7,
        "materials": ["Air", "Au", "SiNx", "InxGa1-xAs", "InxGa1-xAs", "Al1-xInxAs", "Al1-xInxAs", "InxGa1-xAs", "Active Core", "InxGa1-xAs", "InP"],
        "moleFracs": [0.0, 0.0, 0.35, 0.53, 0.53, 0.52, 0.52, 0.53, 0.53, 0.53, 0.0],
        "dopings": [0.0, 0.0, 0.0, 1200.0, 90.0, 2.0, 3.0, 0.5, 0.5, 0.5, 0.0],
        "width": [1.0, 0.45, 0.4, 0.01, 0.5, 0.5, 0.6, 0.2, 1.384, 0.2, 2.0],
        "mobilities": [null, null, null, null, null, null, null, null, null, null, null],
        "custom": {"Active Core": {"index": "(3.286+0j)", "period": [346.0, 40], "gain": 53.4}}
    }
}

```

--------------------------------

### Run ErwinJr2 and create shortcut

Source: https://erwinjr2.readthedocs.io/en/stable/manual/install.html

Start the software with the ErwinJr command, or create a desktop shortcut with ErwinJr-genshortcut.

```bash
ErwinJr

```

```bash
ErwinJr-genshortcut

```

--------------------------------

### Build C library and run without installation

Source: https://erwinjr2.readthedocs.io/en/stable/manual/install.html

Build the C library manually with make and make MP, then run the software without installation by setting PYTHONPATH to the code directory.

```bash
cd [PATH_TO_THE_CODE]/ErwinJr2/OneDQuantum
make
make MP

```

```bash
cd [PATH_TO_THE_CODE]
PYTHONPATH=[PATH_TO_THE_CODE] python ErwinJr2

```

--------------------------------

### Construct and plot QCLayers with QCPlotter

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/QCPlotter.rst.txt

Example of loading a QCLayers instance from a JSON file, solving for eigen states, and plotting potential and wave function. Make sure the sample JSON file (referenced as PQLiu.json) is available and run with the appropriate working directory.

```python
from ErwinJr2 import SaveLoad
from ErwinJr2.QCPlotter import plotPotential, plotWF
import matplotlib.pyplot as plt

with open("../ErwinJr2/example/PQLiu.json", 'r') as f:
    qcl = SaveLoad.qclLoad(f)

qcl.populate_x()
qcl.solve_whole()
plotPotential(qcl)
plotWF(qcl)
plt.xlabel('Position (Å)')
plt.ylabel('Energy (eV)')
plt.show()
```

--------------------------------

### Run ErwinJr2 with python -m ErwinJr2

Source: https://erwinjr2.readthedocs.io/en/stable/_sources/manual/install.rst.txt

Run ErwinJr2 after installation using the python -m ErwinJr2 command, or create a desktop shortcut with ErwinJr-genshortcut.

```bash
python -m ErwinJr2
```

```bash
ErwinJr-genshortcut
```
Tokens:
Raw