Welcome to the Developer Repository for XMapTools 4

This repository contains the most recent version of the MATLAB source code of XMapTools not released in a public version yet. All changes compared to the current public version are listed in the Changelog.

XMapTools official website: https://xmaptools.ch

Documentation (work in progress): https://resources.xmaptools.ch

Public repository: https://github.com/xmaptools/XMapTools_Public

This work is licensed under a GPL-3.0 license.

How to join the developer team?

Contact [email protected]

How to get started

You can pull the current developer version of XMapTools from this directory using the main branch. As changes are not all pushed at the same time, some functionalities of the git version could not work due to compatibility issues. Check the public repository if you are looking for a stable version of XMapTools.

Requirements

• MATLAB R2020b with the Statistics Toolbox, Image Processing Toolbox, Mapping Toolbox. Compatibility with more recent version of MATLAB is not checked.
• For compatibility reasons, you must use MATLAB R2020b if you wish to share modifications made with the MATLAB App Designer.

Warnings

• Never overwrite the main branch if you're not invited to do so; create your own branch if you want to push changes to the server!
• We recommend you to copy the files to a separate folder and to work there in order to avoid any modification of the main branch.

Installation/Update and first steps

• Pull the current developer version of XMapTools from this directory using one of the active branch
• Copy the files to your XMapTools setup directory (a different folder from the GIT: e.g. Documents/XMapTools4/)
• Install MATLAB 2020b and the required toolboxes (see above); it is recommended to use MATLAB 2020b if you want to change the code of XMapTools via the app designer (older versions won't work, newest versions might cause troubles)
• Open MATLAB and navigate to your setup directory
• Type in the MATLAB Command Window >> install_MATLAB
• Type in the MATLAB Command Window >> RESET_CONFIG
• Change the Current Path in MATLAB to a directory containing data
• To launch XMapTools use the command: >> XMapTools
• To open the app designer, use the command: >> start XMapTools