Skip to content

This developer repository contains the latest version of the XMapTools source code. The code on the main branch is usually stable and working, but not fully tested. The compiled beta versions are usually safe and can be used to test the new features of XMapTools.

License

Notifications You must be signed in to change notification settings

xmaptools/XMapTools_Developers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XMapTools_Github_developer

Welcome to the Developer Repository for XMapTools 4

Maintenance Website xmaptools.ch Open Source? Yes!

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

GNU-GPLv3
This work is licensed under a GPL-3.0 license.

How to join the developer team?

Contact pierre.lanari@unil.ch

How to get started

You can download or fetch the current development version of XMapTools from this directory using the main branch. Since changes are not all committed at the same time, some features of the git version may 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 (since 4.1), and Deep Learning Toolbox (since 4.4). Compatibility with later versions of MATLAB is not guaranteed, but XMapTools developer seems to behave well in MATLAB 2025a.
  • You must use the base version of MATLAB (currently MATLAB R2020b) if you want to share changes made to MLAPP files with the MATLAB App Designer. Note that this is not necessary for editing MATLAB code files (.m), which can be done with more recent versions of MATLAB.
  • For compatibility reasons, and because MLAPP files are binary files and code changes cannot be tracked by GitHub, it is important to export the MLAPP file to a MATLAB code file (.m) in the SourceControl folder so that changes to MLAPP files can be tracked. Any pull request containing comits that are missing source control files will be rejected.

Warnings

  • Never overwrite the main branch if you're not invited to do so but create a pull request; 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

About

This developer repository contains the latest version of the XMapTools source code. The code on the main branch is usually stable and working, but not fully tested. The compiled beta versions are usually safe and can be used to test the new features of XMapTools.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •