Skip to content

How to install Finnee2016

Guillaume Erny edited this page Nov 23, 2017 · 26 revisions

Downloading the functions

Finnee can either be download from a particular release or by interfacing Matlab with the Finnee2016 GitHub repository.

From releases

Releases are usually made upon publication of a manuscript. They are a snapshot of the toolbox at a particular date. We assigned a DOI to each version using Zenodo to facilitate citations. The following releases have been made:

Finnee

Finnee was the original version. It should not be used and will not be modified anymore.

Finnee2016

Using GitHub

GitHub is a software repository that allows collaborative work as well as source control. Since Matlab 2014a, GitHub repositories are accessible by the Matlab environment. How to "Clone a remote Git™ repository to retrieve repository files.

  1. Right-click in the white space (any blank area) in the Current Folder browser, and select Source Control>Manage Files.
  2. In the Manage Files Using Source Control dialogue box, choose Git from the Source control integration list.
  3. Click Change to browse for and validate the repository path. (If you know your repository location, you can paste it into the Repository Path box and proceed to step 7.)
  4. In the Select a Repository dialogue box, specify the repository path by entering the path in the box, using the list of new repositories, or by using the Browse to a Git repository on disk button. The Path to Finnee2016 is https://github.com/glerny/Finnee2016.git path2finnee
  5. Click Validate to check the repository path. If the path is invalid, check it against your source control repository browser.
  6. If you see an authentication dialogue box for your repository, enter login information to continue.
  7. When you have finished specifying the path you want to retrieve, click OK.
  8. In the Manage Files Using Source Control dialogue box, select the sandbox folder where you want to put the retrieved files, and click Retrieve."

It is also possible to download all the files from git here

  1. Select Clone or download
  2. Select Download Zip
  3. Extract all in the folder of destination

Add to Matlab path

After downloading the files, the parent folder (Finnee2016) needs to be added to this search path. With Matlab running, you can add a folder (and subfolder) on the search path either by

The Set Path dialogue box (permanent until removed)

  1. On the Home tab, in the Environment section, click Set Path. The Set Path dialogue box appears.
  2. Use the Set Path dialogue box to modify the search path.
  3. Apply or cancel the search path changes:

Using the Current Folder panel (Only until the next session)

  1. Click on the browse for folder icon to navigate to the parent folder of the folder you want to add

add2path1

  1. Right-click on the target folder
  2. Select add to path|Selected Folders and Subfolders

add2path2


Up           : Where to start?
Next        : mzML files
Previous: Where to start?


Clone this wiki locally