Getting Started

From SweepMe! Wiki
(Redirected from Download)
Jump to navigation Jump to search

Last update for version 1.6.1 (with notes for version 1.5.8)

We recommend to visit our SweepMe! YouTube channel where a series of 'Basics' videos explains the handling of SweepMe!.

System requirements

  • SweepMe! runs on Windows 10 (Version 1809) or higher. We recommend Windows 11, since it is the current live version supported by Microsoft.
  • Since version 1.5.7, SweepMe! is only available as 64-bit application.
  • SweepMe! 1.6 is based on Python 3.14 and Qt 6. SweepMe! 1.5.8 is based on Python 3.9. If you change from version 1.5 to 1.6, please read the Migration guide.

Installation

  • Go to the SweepMe! download page to download and run the WebInstaller. The latest stable version is always presented as first choice.
  • If the WebInstaller does not show any version, a firewall or proxy might block the connection. In this case, download the full installer from the dashboard of your sweep-me.net account, see WebInstaller.
  • Different upgrade versions, e.g. 1.5.8 and 1.6.1, can be installed and used in parallel.
  • Starting from version 1.5.6, unattended installations are supported.

First start

  • Launch SweepMe!, e.g. via the desktop shortcut.
  • On the first start, a short startup wizard asks for a profile name. Each user profile has its own folder for measurement data.
  • From version 1.6, SweepMe! automatically requests a free SweepMe! Pro trial license on a new computer, so that you can test all Pro modules and Pro features. You might be asked to log in with your sweep-me.net account. When the trial has expired, SweepMe! asks whether you would like to extend it. You can also request a trial via Tools → Version Manager → menu License → Activate trial. See Licenses.

Basics

  • SweepMe! has two main tabs: General and Sequencer.
  • The General tab shows the current profile and lets you enter the folder and file name for saving data.
  • The Sequencer tab is where the magic happens. Here, measurement procedures are designed and set up.
  • The elements in the sequencer are called Modules. There are basic modules such as Loop or Hold, and instrument modules such as SMU or Logger that communicate with external hardware via drivers.
  • Learn more about the sequencer tree structure and branches on the Sequencer page.
  • From version 1.6, the free version runs measurements with one active branch in the sequencer. Multiple active branches require SweepMe! Pro. Sequences with several branches can still be loaded and edited. To run one branch, uncheck the modules of all other branches.

First run

  • After the first start, the Mouse example is loaded. It does not need any additional hardware.
  • Press Run and move your mouse. The mouse cursor position is shown in the Plot widget of the dashboard. The example runs until you press Stop.
  • Double-click into the plot to change the plot parameters.
  • Explore further examples via the menu Sequences → Load Example (in version 1.5: Settings → Load Example). The examples are sorted into the groups Basic, Instrument, and Pro. Examples in the group Pro use Pro modules or Pro features. See also Examples.

Saving data

  • SweepMe! automates the creation and filling of data files using the MakeFile module in the sequencer.
  • By default, data is saved in your personal measurement data folder, accessible through File → Open Folder → Measurement Data.
  • Enter a folder name and a file name in the General tab and press Save Data. Check Auto Save Data to save the data automatically after each run. See Saving data for details.
  • With SweepMe! Pro, you can also save data with the Save Bar widget of the Dashboard, which additionally lets you choose a main path outside the measurement data folder.

Creating your own measurements

  • Download additional Modules and Drivers via the menu Tools → Version Manager.
  • Add instruments to the sequencer via drag and drop of the corresponding module. E.g. instruments that read values use the Logger module, while instruments that set values use Switch.
  • Set up the driver, port, and parameters in the tab of the module that is newly generated. See Supported ports for the supported connections, e.g. GPIB, USB, TCPIP, or COM.
  • Add widgets such as Plot, Table, Monitor, Image, or Notes to the dashboard via the menu Widgets to display your measurement results.
  • Save your configuration, including sequencer, dashboard layout, and widget setups, as one file via Sequences → Save Sequence (Ctrl+S). From version 1.6, this file is called a sequence (.seq) and is saved in the Sequences folder by default. In version 1.5, it is called a setting (.set). Settings can still be loaded in version 1.6. This makes it easy to reproduce your measurements later.

Next steps