<commit_before>Open Band Parameters Device Simulator (OBPDS)
=============================================

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

The plan is to begin by providing 1D, zero-current electrostatic simulation of
III-V compound semiconductor heterostructures, similar to Prof. William
Frensley's `Bandprof`_. Next, drift-diffusion current simulation will be added
under the assumption of small band discontinuities. Then large band
discontinuities will be accounted for with thermionic emission boundary
conditions.

Materials parameters are provided by the `Open Band Parameters`_ sister
project.

The `source code`_ and `documentation`_ (coming soon) are graciously hosted
by GitHub.

.. _`BandProf`: https://courses.ece.ubc.ca/480/downloads.htm
.. _`Open Band Parameters`: http://github.com/scott-maddox/openbandparams
.. _`source code`: http://github.com/scott-maddox/obpds
.. _`documentation`: http://scott-maddox.github.io/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 easiest method. Install from `PyPi`_ by running `pip install obpds`
from the command line.

.. _`PyPi`: http://pypi.python.org/pypi

From Github
-----------

First, you will need to install the following prerequisite packages:

- Numpy_
- Scipy_
- Matplotlib_
- OpenBandParams_

.. _`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 page`_, extract its contents, and run
`python setup.py install` from within the extracted directory
(OBPDS is a pure-python library, for now, so no compiling occurs
during this installation).

.. _`github page`: http://github.com/scott-maddox/openbandparams/releases/latest

Documentation
=============

Once you have `openbandparams` installed, check out the `tutorial`_
(coming soon) to get acquainted.

.. _`tutorial`: http://scott-maddox.github.io/obpds/tutorial<commit_msg>editing README<commit_after>Open Band Parameters Device Simulator (OBPDS)
=============================================

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

The plan is to begin by providing 1D, zero-current electrostatic simulation of
III-V compound semiconductor heterostructures, similar to Prof. William
Frensley's `Bandprof`_. Next, drift-diffusion current simulation will be added
under the assumption of small band discontinuities. Then large band
discontinuities will be accounted for with thermionic emission boundary
conditions.

Materials parameters are provided by the `Open Band Parameters`_ sister
project.

The `source code`_ and `documentation`_ (coming soon) are graciously hosted
by GitHub.

.. _`BandProf`: https://courses.ece.ubc.ca/480/downloads.htm
.. _`Open Band Parameters`: http://github.com/scott-maddox/openbandparams
.. _`source code`: http://github.com/scott-maddox/obpds
.. _`documentation`: http://scott-maddox.github.io/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 easiest method. Install from `PyPi`_ by running `pip install obpds`
from the command line.

.. _`PyPi`: http://pypi.python.org/pypi

From Github
-----------

First, you will need to install the following prerequisite packages:

- Numpy_
- Scipy_
- Matplotlib_
- OpenBandParams_

.. _`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 page`_, extract its contents, and run
`python setup.py install` from within the extracted directory
(OBPDS is a pure-python library, for now, so no compiling occurs
during this installation).

.. _`github page`: http://github.com/scott-maddox/obpds/releases/latest

Documentation
=============

Once you have OBPDS installed, check out the `tutorial`_
(coming soon) to get acquainted.

.. _`tutorial`: http://scott-maddox.github.io/obpds/tutorial
{'fraction_non_alphanumeric': 0.13372214122057904, 'fraction_numerical': 0.0029160591543428453, 'mean_word_length': 4.519540229885058, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6554156', 'n_tokens_mistral': 1520, 'n_tokens_neox': 1397, 'n_words': 482}