Installation
Before installing, you might want to check the Software Requirements.
There are four categories for installing the software:
- You just want to use the SignalIntegrityApp GUI based solution - this is the simplest and smallest.
- You also want to use the SignalIntegrity library for Python scripted solutions - this assumes that you will be programming in Python. It assumes that you are not a SignalIntegrity developer.
- You want to contribute to the development of SignalIntegrity.
In this installation method, you will:
- Download the small released zip file.
- Install the software.
- Run the SignalIntegrityApp GUI based software.
The SignalIntegrity software runs under Python. You must have some sort of Python 2.7 installation on your machine, or as of 1.0.4, you can run a Python 3.6 or greater installation. SignalIntegrity will run under that installation. There are no binaries for SignalIntegrity and no matter which platform you are on, Linux or Windows, it will run under that Python installation, OS independent. The SignalIntegrityApp GUI based application uses the native Tkinter for it's GUI operation. Tkinter is part of any Python installation by default, so there are no extra libraries to install.
Releases are found on the releases page. Click on the link named SignalIntegrity-A.B.C. This will open a download link. Download and extract this software to a project or work directory. The top directory of the extracted software will be SignalIntegrity, so you don't need to create this directory. You can then install and run the software.
Before installing, you might want to check the Software Requirements.
If you use pip for installing your Python packages (recommended), then, from within your SignalIntegrity directory (where the setup.py file is located) type:
pip install -e .
You probably need administrator privileges, so on Linux, type:
sudo -H pip install -e .
If you don't have pip installed, or don't want to use it, type:
python setup.py develop
or in Linux, you should type:
sudo -H python setup.py develop
Then you can run the software. You can also write Python scripts using SignalIntegrity. If you want to export plots in the LaTeX style tikz format (otherwise known as pgfplots), you will need to install the package:
tikzplotlib
That must be done manually, as the installation does not force that.
To run the SignalIntegrityApp GUI application, type:
SignalIntegrity
If everything was installed correctly, this should just work. If not, see Installation Issues. The SignalIntegrityApp help system is online and can be accessed within the application.
To write scripts that utilize the SignalIntegrity tools, from within your Python script, type:
import SignalIntegrity.Lib as si
then, all of the classes and functions are accessed with si.xxx where xxx is the desired namespace. The documentation for SignalIntegrity is online.
If the documentation for writing scripts using SignalIntegrity is not adequate, it helps to have all of the Test software on your machine. (see source download).
Sometimes there are installation issues. The usual issues are:
- The SignalIntegrityApp GUI based software cannot be found by the system.
- The SignalIntegrity library cannot be found from within Python.
Both problems are solved by adding the location of your SignalIntegrity project to the PYTHONPATH environment variable.
You can always start the SignalIntegrityApp by navigating to your SignalIntegrity project, changing directories two levels down to /SignalIntegrity/App, and typing:
python SignalIntegrityApp.py
If you will use the SignalIntegrity software for scripted solutions using the SignalIntegrity library, you will benefit from a large source installation. This installation contains everything in the release along with the Test directory. The files in the Test directory test the entire SignalIntegrity library, and as such provide good examples for the utilization of this library beyond that documented in the SignalIntegrity online documentation. Fortunately, the tests cover nearly 100% of the library. Unfortunately, the Test directory is huge.
For this installation:
- Download the source
- Install the software.
- Run the SignalIntegrityApp GUI based software.
- Write Python scripts using SignalIntegrity
Source can be downloaded by either as released source or the master branch. The master branch should be up to date with the latest release. The released source is found in either .zip or .tar.gz at releases page. The .zip for the master branch can be downloaded from the SignalIntegrity Main page.
Download and extract this software to a project or work directory. The top directory of the extracted software will be SignalIntegrity-master, so you don't need to create this directory. You can then install and run the software.
These instructions are for non-developers of SignalIntegrity and do not utilize git. If you want, you can install a developer environment instead.
SignalIntegrity is brought to you by:
