Compatibility Issues

This software is written in Java, which means that it can theoretically be run on any system that has the Java Runtime Environment (JRE) installed on it. It is recommended that this software be used with Windows, however, as it was developed and tested under the Windows operating system, and the interface's appearance was developed under Windows. Although the software should theoretically run under OS X, Linux, Solaris or any other operating system with the JRE installed on it, users should be advised that the software has not yet been fully tested on other platforms, so difficulties may be encountered.

This software was developed with version 1.6.0_16 of the JDK (Java Development Kit), so it is suggested that the corresponding version or higher of the JRE be installed on the user's computer.

Installing the Java Runtime Environment

If your system already has the JRE installed, as will most typically be the case, you may skip this section. If not, you will need to install the JRE in order to run this project. The JRE can be downloaded for free from the Java web site. The JDK typically includes the JRE, or the JRE can simply be installed alone.

When the JRE download is complete, follow the installation instructions that come with it in order to install it.

Installing jWebMiner

The project can be accessed at http://jmir.sourceforge.net. This distribution includes a pre-compiled Jar file, the source code and extensive documentation. All of this is delivered in a zipped file, from which the project files can be extracted.

There are two versions of the project, namely the developer version and the user version. The user version contains everything needed to run the project, but does not include any source code. The developer version does include source code, presented in the form of a NetBeans project.

The user version unzips into a single directory. Installation simply involves copying this directory into any desired location.

The following directories are contained in the developer zip file:

• jWebMiner2: The jWebMiner2 project, presented in the form of a NetBeans project. Contains the following directories and files:
  • dist: Contains a pre-compiled jWebMiner2.jar file (and associated libraries) for direct inclusion in other projects.
  • javadoc: Javadoc documentation for the project source code.
  • Licenses: Licenses associated with the project and its dependencies.
  • nbproject: NetBeans project files. This is only relevant to those wishing to use the software in a NetBeans IDE context; it is certainly possible to use the software in other development environments as well.
  • ProgramFiles: Contains files used by the software.
  • SampleFiles: Files that can be used to help learn the software.
  • src: The project's source code.
  • build.xml: NetBeans build instructions. Only relevant if using the NetBeans IDE.
  • manifest.mf: The manifest used when building the project Jar file.
  • Manual.html: The software's manual.
  • README.txt: Basic overall documentation of the project.
• Third_Party_Jars: Contains the distributable third-party software used by the project. Also includes the jar files for other jMIR projects that this project has as adependencies. These need to be included in the jMusicMetaManager build (in the NetBeans context, this means adding the jar files found here as libraries).

-top of page-