This is the main repository for the open source SemiPy data analysis framework. SemiPy is meant for plotting, analyzing, modeling, and documenting semiconductor electronic devices.
This README is geared towards users that want to make contributions to the SemiPy code. If you are only interested in using SemiPy for your own data anlysis, then you should just install SemiPy as a python package. Go to this link to follow installation instructions.
As most users of SemiPy do not have experience contributing to open source projects, this Readme will discuss the code contributing process.
Working on open source projects is a good way to improve your code skills, make an impact to the field, and adjust the project to better meet your needs (and likely someone else's).
Most contributors are graduate students working on semiconductor device research, but anyone can make contributions has long as they demonstrate sufficent domain knowledge of semiconductors.
To join the SemiPy contributors list, we recommend you send the current project leader an email outlining why you would like to join and attach your resume.
SemiPy is broken into three main categories: (1) Datasets for plotting and extracting data from semicondcutor device data (2) Database for recorrding properties of materials and devices (3) Modeling for modeling the physics of semiconductor devices
To make contributions to each SemiPy subsection, look at the README.md files in their respective repositories
Making contributions to the database is the simplest way to make SemiPy contributions.
To install the necessary libraries, make a virtual environment and install the python packages in the requirements.txt file.
virtualenv -p python3 env
source env/bin/activate
pip install -r requirements.txt
Make sure to have python3 installed and callable on your machine.
Using the Command Line, navigate to the directory you want install SemiPy.
make sure to install orca for plotting by running
sudo apt install orca