Downloading and installing WellReader

  1. Downloading and installing WellReader
    1. System Requirements
    2. Downloading WellReader
      1. Archives of releases
      2. Using subversion
    3. Running WellReader
  2. Using source code
  3. Using compiled code
    1. License
    2. Release history
    3. See also

WellReader is written in MATLAB and is available both as source code (M files) and compiled code (platform-specific binary files).

System Requirements

The program was tested on MATLAB 7 for both Linux and Windows. WellReader uses the Spline Toolbox. Note that this toolbox is not included in the student version of MATLAB. WellReader is also available in a stand-alone version, obtained after compilation for Linux and Windows platforms.

Downloading WellReader

WellReader's development is managed using subversion, an open-source control revision system. Thus you can retrieve WellReader either by downloading a compressed archive of tagged releases, or by using subversion.

Archives of releases

Zip archives of the trunk branch and/or tagged releases can be easily retrieved using trac's browsing interface (the link can be found at the end of each page, under Download in other formats). Prefer using the latest tagged release (currently 3.0).

Using subversion

Use subversion's client to retrieve the directory's files. The client is free software and available for almost every platform, including Linux, Windows and MacOS X. The server hosting the files is https://prabi1.inrialpes.fr.

Source files are organized in a development tree. Normally, you should be interested in the latest tagged release only. However, if you are a developer, you may want to have a look at SVNTree for more information on previous releases. You can also browse the repository.

If you only want one tagged release, e.g., the 3.0 release, simply checkout that specific folder:

svn co https://prabi1.inrialpes.fr/svn/GNATeam/wellreader/tags/wellreader-3.0

If you instead want the whole development tree, do a checkout of the root:

svn co https://prabi1.inrialpes.fr/svn/GNATeam/wellreader

At any time, you can update your local repository and get the latest version. Of course, this is meaningless for tagged releases as these will not change. Instead you should check if there is a more recent release in the source:tags branch). Here is how to do this:

svn update

Running WellReader

Using source code

Once you have downloaded the files, simply launch MATLAB and set your working directory to that of the downloaded files. If you retrieved a compressed archive, you need to extract it first. Then launch WellReader's interface with the following command:

> wellreader

The main window should appear and you can start using the application.

Using compiled code

If MATLAB is not installed on your machine, you can use the standalone executable of WellReader obtained by means of the Compiler Toolbox of Matlab. Currently a Windows version is available that has been tested on Windows XP and Vista. Download the files as described above, go to the executables directory, and unpackage the application by means of

> wellreader_3.0_standalone_Windows_pkg.exe

You can now run WellReader by typing

> wellreader_3.0_standalone_Windows.exe

Notice that under Windows Vista an error message is generated when launching the application. This error message does not interfere with the functioning of the program and should be ignored.

License

WellReader is a Free Software application covered by the Lesser General Public License, Version 2 or later (LGPL license)

Release history

Note: Releases within the 2.x branch sometimes contain bugs, so do not use them!

See also