From 800c452fa1b16dcdd19f977c14970aa25b2fe20d Mon Sep 17 00:00:00 2001 From: Christoph Schmidt <christoph.,schmidt@tugraz.at> Date: Mon, 22 Jan 2024 13:33:43 +0100 Subject: [PATCH] Updated README.md --- README.md | 20 ++++++++++---------- requirements.txt | 12 ++++++------ 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f324ba6..ff1de8d 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ -## Still under construction - - -*This repository is under construction*. It will be restructured after all individual parts are updated. -You can find the dependencies in the gitlab parent folder of this repo. # Flexsensor + + An automation software for [FormFactor Cascade Summit200](https://www.formfactor.com/product/probe-systems/200-mm-systems/summit200/) Probe Stations. *FlexSensor* is a software that allows to automate measurements using the FormFactor Wafer Prober. *FlexSensor* is a standalone Python application. Its versatility allows for immediate deployment, without prior programming knowledge. Particularly noteworthy are its post-processing capabilities, however, the software's core functionality is the use of the automated measurement routine to acquire the resonant spectra of photonic devices, integrated within a specialized measurement system, as detailed in Section +## Still under construction* +This repository is under construction. The software is ready for deplyoment but is still in beta. +If you find any bugs or have any suggestions, please open an issue. + + + # Installation -Create a virtual environment (highly recommended) +Create a virtual environment (highly recommended) and install the dependencies. ```python python -m venv .venv source .venv/Scripts/Activate -``` -Prior to using the software, these packages need to be installed. -``` -pip install rich PySide6 pyyaml matplotlib pyqtgraph pandas scipy numpy +pip install -r requirements.txt ``` # Measuring using Flexsensor diff --git a/requirements.txt b/requirements.txt index e3fa87a..ce89340 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,14 +6,14 @@ pyqtgraph pandas # Custom added packages -git+https://gitlab.tugraz.at/flexsensor-public/modules/confighandler.git@develop -git+https://gitlab.tugraz.at/flexsensor-public/modules/fswidgets.git@develop -git+https://gitlab.tugraz.at/flexsensor-public/captdevicecontrol.git@develop -git+https://gitlab.tugraz.at/flexsensor-public/lasercontrol.git@develop -#git+https://gitlab.tugraz.at/flexsensor-public/mcpy.git@develop +git+https://gitlab.tugraz.at/flexsensor-public/modules/confighandler.git@main +git+https://gitlab.tugraz.at/flexsensor-public/modules/fswidgets.git@main +git+https://gitlab.tugraz.at/flexsensor-public/captdevicecontrol.git@main +git+https://gitlab.tugraz.at/flexsensor-public/lasercontrol.git@main +git+https://gitlab.tugraz.at/flexsensor-public/mcpy.git@main #../tools/confighandler #../captdevicecontrol #../lasercontrol -../mcpy +#../mcpy #../tools/fswidgets \ No newline at end of file -- GitLab