Versioning: Difference between revisions

From SweepMe! Wiki
Jump to navigation Jump to search
(Created page with "Last updated for: Version 1.5.3.15 SweepMe! is under continuous development. This article will inform you about the meaning of the version number and how to handle SweepMe! v...")
 
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Last updated for: Version 1.5.3.15
Last updated for: Version 1.5.5


SweepMe! is under continuous development. This article will inform you about the meaning of the version number and how to handle SweepMe! version in order to simplify migratio to a newer version.
SweepMe! is under continuous development. This article will inform you about the meaning of the version number and how to handle different SweepMe! versions in order to simplify the migration to a newer version.
 
To get informed about new versions, follow us on [https://www.linkedin.com/company/sweepme LinkedIn] or [https://twitter.com/sweep_me_net Twitter].
 
 
== Versions ==
 
{| class="wikitable"
|+ Table of SweepMe! upgrade version releases
|-
! Upgrade version !! First live release !! End of support !! Changes !! OS !! Comment
|-
| 1.5.7 || (2025, January) || not defined yet || - || - || under development
|-
| 1.5.6 || 2024, January || not defined yet || https://sweep-me.net/changes/version_1-5-6 || Windows 10 or higher || -
|-
| 1.5.5 || 2020, October || 2023, December || https://sweep-me.net/changes/version_1-5-5 || Windows 7 or higher || -
|-
| 1.5.4 || 2019, April || 2020, December || not available || Windows 7 or higher || -
|}
 
Versions before 1.5.4 have not been publically available and therefore are not listed here.


== Version number ==
== Version number ==


A SweepMe! version consists of 4 number e.g. 1.5.3.14
A SweepMe! version consists of up to 4 numbers e.g. 1.5.5.48


The possitions have the following meaning:
The positions have the following meaning:


# The first number is related to the basic architecture of SweepMe! and this number would change if we would rebuild SweepMe! from scratch.
# The first number is related to the basic architecture of SweepMe! and this number would change if we would rebuild SweepMe! from scratch.
# The second number indicates a major change of the program that typically involves larger compatibility breaks.
# The second number indicates a major change of the program that typically involves larger compatibility breaks.
# The third number refers to the development of new features, contents, optimizations etc. Smaller compatibility breaks are possible but we try to keep the program downward compatible as much as possible.
# The third number refers to the development of new features, contents, optimizations etc. Smaller compatibility breaks are possible but we try to keep the program downward compatible as much as possible.
# The last number corresponds to the iterative bugfixing and testing that has been done so far for the version related to the frist three numbers.
# The last number corresponds to the iterative bugfixing and testing that has been done so far for the version related to the first three numbers.
 
An upgrade version is indicated by using the first three numbers, e.g. 1.5.5 and the last number is omitted that only indicates the updates.


== Version handling ==  
== Version handling ==  


Multiple versions of SweepMe! can be installed on the same computer at the same time. To keep track of all version we recommend the following directory structure:
=== Updating ===


C:\SweepMe!\SweepMe!_x.x.x.x
To update your SweepMe! installation to the latest stable version use ''Help & Info'' -> ''Update''.
 
=== Installing Specific Version ===
 
If you wish to install a specific version or a beta version, use ''Help & Info'' -> ''Upgrade''. This will initiate the Web Installer, where you can select the version you want to install.
 
=== Multiple Installations ===


where x.x.x.x is the version number. If you like to change to a newer version, you can install it in parallel to your existing version in order to test your settings. If everything works, the old version can be removed just by deleting the folder. SweepMe! does not change the registry of the operating system.
Multiple versions of SweepMe! can be installed on one computer at the same time. To keep track of all versions we recommend the following directory structure:


== Migration to a newer version ==
C:\SweepMe!\SweepMe!_x.x.x.x


where x.x.x.x is the version number. If you like to change to a newer version, you can install it in parallel to your existing version in order to test your settings. Some adaptions might be needed to make your old settings work again. Learn more here in our [[Migration_guide | migration guide]].
If everything works again, the old version can be removed just by deleting the folder. SweepMe! does not change the registry of the operating system, so uninstalling SweepMe! via the operating systems is not needed.


=== Migration to version 1.5.3.x ===
Starting from version 1.5.4, the folder will only contain three numbers:


* When using the installer, a path like "C:\SweepMe!\SweepM!x.x.x.x." will be suggested. Thus, different versions can be installed at the same time. However, please make sure that there is no old version in "C:\SweepMe!" that has not yet any version-related subfolder.
C:\SweepMe!\SweepMe!_x.x.x


* Setting are now stored in a public folder of the public user of the operating system. Copy your old settings from your previous version to the public settings folder that you can find via File -> Open Folder -> Settings
== Update vs. Upgrade ==
As the last number of the version is related to bugfixes, you can always update SweepMe! e.g. from version 1.5.3.15 to version 1.5.3.16 or higher without having trouble with changes in the program. If you encounter any bugs, please check first whether any download for your version, e.g. 1.5.3.x is available.


* SweepScripts are now stored in a public folder of the public user of the operating system. Copy your old SweepScripts from your previous version to the public SweepScripts folder that you can find via File -> Open Folder -> Public
An upgrade is basically done if not just the last number of the version changes, e.g. a change from version 1.5.3.x to version 1.5.4.x. In that case, you have to read the pages of changes and the [https://wiki.sweep-me.net/wiki/Migration_guide migration guide] to make sure that you do not miss any relevant changes.


* Calibration files, e.g. used for the Device Classes of the Spectrometer module, are now stored inside a public folder as well. Copy your calibrations to the folder 'CalibrationFiles' inside the public folder which can be found via File -> Open Folder -> Public.
== Support policy ==


* Whenever Device Classes need external libraries such as dll files, they can be saved now in the folder 'ExternalLibraries' which can be found inside the public folder (File -> Open Folder -> Public)
So far, we are developing 1.5 versions, like 1.5.4.x, 1.5.5.x, and 1.5.6.x which means that we introduce new features but do not introduce major breaks. Here, we always maintain and fix the latest 1.5.x version and we encourage users to upgrade to the latest 1.5.x version for which we provide fixes of bugs and security issues.


* Your measurement data will be saved now in the folder 'Measurement' located in the public folder (File -> Open Folder -> Public). Please renew any desktop link that you created to easily find your data.
Once, we release a 1.6 version, we will support the last 1.5.x version for a couple of time, to allow users that purchased a bundle of add-on modules to be able to use it. As there is no plan to release a 1.6 version, we did not define an end of support for 1.5 yet.


* Check your settings and renew them if needed.
== Modules & Devices ==


* Device Class development: It might be necessary to change the use of the function "set_GUIparameter". The dictionary which is returned by this function must now contain all keys related to GUI elements that should be enabled and a corresponding default values. Thus, users can see which parameters are supported by a Device Class.
[[Modules]] and [[Device Class|Devices]] are versioned via our server when they are uploaded by the maintainer. Each version has an ID and a name that is based on the date of the upload, e.g. '2019-11-02' if the upload was at the 2nd November of 2019. If there are multiple uploads of the same module or device at the same day, the name gets an suffic, e.g. '2019-11-02-r2'


* Device Class development: In case your Device Class was developed for the Module Logger or Switch, the Parameters-Line is no longer available. Instead, you can dynamically create GUI elements yourself, just by returning keys and default values using "set_GUIparmeter"
You can download and update Modules and Devices via the [[Version manager]] that comes with SweepMe!.

Latest revision as of 14:31, 19 February 2024

Last updated for: Version 1.5.5

SweepMe! is under continuous development. This article will inform you about the meaning of the version number and how to handle different SweepMe! versions in order to simplify the migration to a newer version.

To get informed about new versions, follow us on LinkedIn or Twitter.


Versions

Table of SweepMe! upgrade version releases
Upgrade version First live release End of support Changes OS Comment
1.5.7 (2025, January) not defined yet - - under development
1.5.6 2024, January not defined yet https://sweep-me.net/changes/version_1-5-6 Windows 10 or higher -
1.5.5 2020, October 2023, December https://sweep-me.net/changes/version_1-5-5 Windows 7 or higher -
1.5.4 2019, April 2020, December not available Windows 7 or higher -

Versions before 1.5.4 have not been publically available and therefore are not listed here.

Version number

A SweepMe! version consists of up to 4 numbers e.g. 1.5.5.48

The positions have the following meaning:

  1. The first number is related to the basic architecture of SweepMe! and this number would change if we would rebuild SweepMe! from scratch.
  2. The second number indicates a major change of the program that typically involves larger compatibility breaks.
  3. The third number refers to the development of new features, contents, optimizations etc. Smaller compatibility breaks are possible but we try to keep the program downward compatible as much as possible.
  4. The last number corresponds to the iterative bugfixing and testing that has been done so far for the version related to the first three numbers.

An upgrade version is indicated by using the first three numbers, e.g. 1.5.5 and the last number is omitted that only indicates the updates.

Version handling

Updating

To update your SweepMe! installation to the latest stable version use Help & Info -> Update.

Installing Specific Version

If you wish to install a specific version or a beta version, use Help & Info -> Upgrade. This will initiate the Web Installer, where you can select the version you want to install.

Multiple Installations

Multiple versions of SweepMe! can be installed on one computer at the same time. To keep track of all versions we recommend the following directory structure:

C:\SweepMe!\SweepMe!_x.x.x.x

where x.x.x.x is the version number. If you like to change to a newer version, you can install it in parallel to your existing version in order to test your settings. Some adaptions might be needed to make your old settings work again. Learn more here in our migration guide. If everything works again, the old version can be removed just by deleting the folder. SweepMe! does not change the registry of the operating system, so uninstalling SweepMe! via the operating systems is not needed.

Starting from version 1.5.4, the folder will only contain three numbers:

C:\SweepMe!\SweepMe!_x.x.x

Update vs. Upgrade

As the last number of the version is related to bugfixes, you can always update SweepMe! e.g. from version 1.5.3.15 to version 1.5.3.16 or higher without having trouble with changes in the program. If you encounter any bugs, please check first whether any download for your version, e.g. 1.5.3.x is available.

An upgrade is basically done if not just the last number of the version changes, e.g. a change from version 1.5.3.x to version 1.5.4.x. In that case, you have to read the pages of changes and the migration guide to make sure that you do not miss any relevant changes.

Support policy

So far, we are developing 1.5 versions, like 1.5.4.x, 1.5.5.x, and 1.5.6.x which means that we introduce new features but do not introduce major breaks. Here, we always maintain and fix the latest 1.5.x version and we encourage users to upgrade to the latest 1.5.x version for which we provide fixes of bugs and security issues.

Once, we release a 1.6 version, we will support the last 1.5.x version for a couple of time, to allow users that purchased a bundle of add-on modules to be able to use it. As there is no plan to release a 1.6 version, we did not define an end of support for 1.5 yet.

Modules & Devices

Modules and Devices are versioned via our server when they are uploaded by the maintainer. Each version has an ID and a name that is based on the date of the upload, e.g. '2019-11-02' if the upload was at the 2nd November of 2019. If there are multiple uploads of the same module or device at the same day, the name gets an suffic, e.g. '2019-11-02-r2'

You can download and update Modules and Devices via the Version manager that comes with SweepMe!.

Retrieved from "https://wiki.sweep-me.net/index.php?title=Versioning&oldid=5362"