scott-maddox / obpds

A free, open-source technology computer aided design software for simulating semiconductor structures and devices.
GNU Affero General Public License v3.0
9 stars 4 forks source link

Open Band Parameters Device Simulator (OBPDS)

A free, open-source technology computer aided design software for simulating semiconductor structures and devices.

OBPDS currently provides 1D electrostatic simulation of III-V compound semiconductor heterostructures, similar to Prof. William Frensley's Bandprof. Materials parameters are provided by the Open Band Parameters sister project.

If you would like to try OBPDS before installing it, check out the interactive tutorial_.

The source code_ is graciously hosted by GitHub.

.. BandProf: https://courses.ece.ubc.ca/480/downloads.htm .. Open Band Parameters: http://github.com/scott-maddox/openbandparams .. interactive tutorial: http://mybinder.org/repo/scott-maddox/obpds-binder/tutorial.ipynb .. source code: http://github.com/scott-maddox/obpds

Installation

In order to use OBPDS, you must having a working Python_ distribution installed. Python 3 support has not yet been tested, so Python 2.7 is suggested.

.. _Python: https://www.python.org/download/

From PyPi

This is the recommended method for installing OBPDS. PyPi is the python package index, which contains many python packages that can be easily installed with a single command. To install OBPDS from PyPi, open up a command prompt and run the following command::

pip install obpds

.. _PyPi: http://pypi.python.org/pypi

From Source

In order to install OBPDS from source, you must fist install the following prerequisite packages:

.. Numpy: http://docs.scipy.org/doc/numpy/user/install.html .. Scipy: http://www.scipy.org/install.html .. Matplotlib: http://matplotlib.org/users/installing.html .. OpenBandParams: http://scott-maddox.github.io/openbandparams/installation.html

Once these are installed, download the latest release .zip or .tar.gz source package from the github releases_ page, extract its contents, and run python setup.py install from within the extracted directory.

.. _github releases: http://github.com/scott-maddox/obpds/releases/latest

Documentation

Interactive documentation is hosted through mybinder.org. If you have difficulty accessing the interactive version, a static version is available here.

.. documentation: http://mybinder.org/repo/scott-maddox/obpds-binder .. here: https://github.com/scott-maddox/obpds-binder/blob/master/index.ipynb