SDTest - Software Defined Test

SDTest (Software-Defined Test) can be implemented (through embedding or installation) in all kinds of testing equipment or machinery. By performing image processing on a deep-learning basis, SDTests can be utilized in a wide range of fields such as industrial product manufacturing, pharmaceutical manufacturing, manufacturing of synthetic fibers and natural woven fabrics, infrastructure inspection, semiconductor manufacturing, sorting of agricultural products, and so on.

License

Copyright (c) 2019 RUTILEA, Inc.

This program is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 or later as published by the Free Software Foundation.

This program can be distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Getting Started

Requirements

• Operating Systems
  • Windows 7 or later (64-bit)
  • Ubuntu 16.04 or later (64-bit)
  • macOS 10.12.6 (Sierra) or later (64-bit) (no GPU support)
• Processors
  • Intel or AMD x64 processor
  • AVX (Advanced Vector Extensions) supported
• GPU Cards (Optional)
  • CUDA™-enabled GPU card on Ubuntu or Windows
  • If the supported GPU is unavailable, CPU will be used instead
• Disk
  • Minimum: 1 GB of HDD space
  • Recommended: An SSD
• RAM
  • Minimum: 4 GB
  • Recommended: 8 GB
  • For Polyspace, 4 GB per core is recommended

Installation

Download the latest release and run the installer.

Development

Dependencies

• git
• Python 3.6 with pip
• Qt Designer
• Any IDE: PyCharm, IntelliJ IDEA or VSCode is recommended.
• (Optional) Windows SDK for code-signing on Windows

Deployment

• git clone [email protected]:RUTILEA/SDTest.git clones the repository into "SDTest" directory
• cd SDTest
• python -m venv your_venv creates a virtual environment in the project directory (Choose your own virtual environment name).
• Activate the virtual environment as your OS:
  • On Mac/Linux: source your_venv/bin/activate
  • On Windows: call your_venv\scripts\activate.bat
• pip install -r requirements/base.txt -U installs the required libraries (most notably, fbs and PyQt5). If this produces errors, try pip install wheel first and try again.
• pip install -r requirements/(YOUR-OS).txt -U installs the additional required libraries for your operating system. Replace "(YOUR-OS)" in the command with one of windows, mac or linux and then execute.

Run the app

• python src/build.py run executes the app and you can debug it on console

Create an UI file (.ui)

1. Run Qt Designer and create an .ui file into src/main/python/view/ui/.
2. After editing ui, convert the .ui file to .py file by the command pyuic5 -o FILENAME.py FILENAME.ui inside that directory. Both .ui and .py files should be stored together there.
3. Create a python file into src/main/python/view/ with the same filename to handle ui behaviors.

Create a static resource file (.qrc)

1. Run Qt Designer and create a .qrc file into src/main/python/.
2. After editing the resources, convert the .qrc file to .py file by the command pyrcc5 -o --import-from qrc FILENAME_rc.py FILENAME.qrc inside that directory. Both .qrc and .py files should be stored together there.

Build an installer

• python src/build.py freeze turns the app's source code into a standalone executable. This creates the folder target/SDTest. You can copy this directory to any other computer (with the same OS as yours) and run the app there.
• python src/build.py installer generates the app's installer into targets/. On Windows, this would be an executable called SDTestSetup.exe. Before you can use the installer command on Windows, please install NSIS and add its installation directory to your PATH environment variable.

Debugging of the standalone executable

• python src/build.py clean
• python src/build.py freeze --debug
• ./target/SDTest/SDTest.exe executes the app and you can debug it on console like src/build.py run

Code-Sign the executables

• If you have a valid code-signing certificate, both freeze and installer commands automatically code-sign the generated .exe files on Windows by placing your certificate file at src/freeze/base/SDTest.pfx.
• This requires SignTool that available as part of the Windows SDK
• Please note that the file extension of the certificate must be .pfx, otherwise it may be shared in the PUBLIC repository.
• Currently automatic code-signing is only implemented for Windows. For others will be supported soon.

Support

• Report issues on the GitHub issue tracker
• Post questions to the Contact form