Installation Instructions for EmisView

1. Installation of third party software. 1

1.1 Install the Java Runtime Environment (JRE) 1.4.2. 1

1.2 Install MySQL 4.1 (or PostgreSQL) 2

1.3 Install R version 2 or later. 4

2. Installation of EmisView.. 5

2.1 Installing EmisView for the First Time. 5

2.2 Updating Your EmisView Installation. 7

 

1. Installation of third party software

 

EmisView needs the following third party software to run: Java (1.4), MySQL (4.1) or PostgreSQL 7.x or 8.x, and R (2.x). If you do not already have the specified versions of these software products installed, please install the current versions of these products before proceeding with the EmisView specific installation instructions in Section 2.   Note: if you are not comfortable with software installations, you may want to have an IT support person perform the steps in this section.

 

1.1 Install the Java Runtime Environment (JRE) 1.4.2

1.      Note: a problem has been found with using Java 1.5 with EmisView.  For now, we need to use Java 1.4. You can download this version from http://java.sun.com/j2se/1.4.2/download.html.

2.      Scroll down and click on the link named “Download J2SE JRE”.  You will be taken to a page with a license agreement.  Examine the agreement and if you agree to the terms,

·        click the Accept License Agreement option,

·        then go to the section for your operating system under the heading “Java™  2 Runtime Environment, Standard Edition 1.4.2_09”.

·        Now, click the link that corresponds to your operating system, e.g., “Windows Offline Installation, Multi-language”.

3.      You will be prompted to save the installation package on your computer.  Choose a location in which to save the installation package and save the file.  Note that you will be able to delete this file after you are finished installing the software.

4.      Execute the Java installation package by using My Computer or Windows Explorer to go to the folder in which you saved the installation package and by double clicking on its icon.  The file should be named something similar to j2re-1_4_2_09-windows-i586-p.exe.

5.      After you double click on the installation package, an installer will start.  Follow the prompts of the installer to accept the license agreement and perform a typical installation.

6.      Note that on Windows, the Java runtime environment is typically installed into a directory similar to C:\Program Files\Java\j2re1.4.2_09.

7.      If the above instructions were not sufficient to obtain a successful installation, more detailed information is available at http://java.sun.com/j2se/1.4.2/install-docs.html.

1.2 Install MySQL 4.1 (or PostgreSQL)

EmisView requires a database to run.  Currently MySQL and PostgreSQL are supported.  Instructions for installing MySQL are provided here.  If you wish to use PostgreSQL, please see the instructions available from http://www.postgresql.org.

 

1.      If you are already have MySQL installed, follow the steps in this section, otherwise proceed to Step 2.

a.       If you have previously installed MySQL 4.0 or earlier, you need to uninstall that version before proceeding with the upgrade. 

b.      To begin the uninstallation, first stop the service, by typing the following command at the command prompt: NET STOP mysql. (If your service is registered under a different name than mysql, please use that name).

c.       Next, remove the service by executing the following command: C:\mysql\bin\mysqld –remove (If MySQL was installed in a different directory, please use the appropriate path e.g. D:\mysql\bin\mysqld --remove)

d.      Next, go to Windows Start Menu à Control Panel à Add or Remove Programs.

e.       Look for MySQL Servers and Clients xxx and click on Change/Remove.

f.        It will ask you Are you are sure you want to remove MySQL Servers and Clients and all its components? Say Yes. Your previous version MySQL will then be uninstalled.

2.      If you are a Windows user, you can download a version of MySQL that has been tested with EmisView from the Downloads section of http://emisview.sourceforge.net and skip directly to Step 3. If you are not a Windows user or prefer the latest version of MySQL, the follow the steps in this step.  Note that instructions for obtaining the Windows install package are provided in this step, but the process should be similar for other operating systems.

a.       Go to http://dev.mysql.com/downloads/mysql/4.1.html.  

b.      Scroll down on this page until you see the section Windows Downloads. 

c.       In the line that starts with Windows Essentials, Click on Pick a mirror. 

d.      The next page gives you a change to enter some information about yourself and how you’re using MySQL.  You may answer these questions if you wish, or you may click on No thanks, just take me to the downloads. 

e.       In either case, you should come to a section titled Mirrors in the United States.  Click on HTTP next to one of the mirror sites.  You may find that choosing a mirror close to you geographically gives you a faster download, but you can click on any one.

f.        You will be prompted to save the MySQL installation package to your computer.  Choose a folder and Save the installation package to the folder on your computer.

g.       Use My Computer or Windows Explorer to go to the folder in which you saved the installation package. The file should be named something similar to mysql-4.1.13-essential-win.msi.

3.      Execute the MySQL installation package (e.g. mysql-4.1.13-essential-win.msi ) by double clicking on its icon. 

a.       Once the installation package has started, click Next and follow the prompts to perform a Typical installation. 

b.      When prompted with setting up an account, you may fill in the information it asks or you may choose to Skip Sign-Up. 

c.       On the last screen of the installation wizard, there is a checkbox for Configure the MySQL server now.  Make sure this is checked before you click Finish. Clicking Finish will start the MySQL Server Instance Configuration Wizard.

4.      On the MySQL Server Instance Configuration Wizard click Next, choose Detailed Configuration for the configuration type and then click Next. When prompted, choose the following options in the wizard:

a.       Server Machine, since it would be advisable not to use your computer for other things while EmisView is running. This setting will help MySQL operations (and therefore EmisView) to execute faster.

b.      Next, choose the Non-Transactional Database Only option, since EmisView currently does not use transactions. This will avoid requiring MySQL to perform additional operations to ensure transaction compliance.  

c.       Next, select the Manual Setting option and set the number of concurrent connections to be 15.

d.      Next, select the Enable TCP/IP Networking checkbox, and select the default port setting (3306).

e.       Select Standard Character Set.

f.        Make sure the Install as Windows Service and the Launch the MySQL Server automatically checkboxes are checked and select MySQL as the Service Name. It is suggested that you also choose to Include Bin Directory in Windows PATH.

g.       On the following page that starts with Please set the security options, check the Modify Security Settings checkbox. enter a New root password and Confirm. Do not check ‘Enable root access from remote machines’ (this is a security risk). Write down the new password you have set for future reference. Leave the Create an Anonymous Account option unchecked.

h.       Once all settings have been selected, you will see a Ready to Execute page with an Execute button at the bottom.  If you are satisfied with the selections you made, click Execute.  Otherwise, you can use the Back or Cancel buttons and change your selections or start over.

 

5.      Using mysql from a command prompt: If you need to access the MySQL server directly, from the command prompt, you can log into the MySQL database by typing this: 
                   mysql –u root –p    and then entering the MySQL root password at the prompt.
Once you are logged in, you should see a message that says “Welcome to MySQL Monitor…..”.
You may issue commands like show databases; and create database dbname from here.

1.3 Install R version 2 or later.

1.      If you are a Windows user, you may download a version of R that has been tested with EmisView from http://emisview.sourceforge.net. If you are not a Windows user or you wish do download the latest version of R, follow the steps in this section.  Note that specific instructions are provided for Windows, but steps should be similar for other operating systems.

a.       Go to  http://cran.us.r-project.org/).  On this page you should see a section labeled Precompiled Binary Distributions.  Click on Windows (95 and later). 

b.      On the R for Windows page, click on the link labeled base.

c.       On the R-2.1.1 for Windows page (not: there may be a version later than 2.1.1. by the time you read this, proceed with that version), click on rw2011.exe (note: the 2011 here is the file name for version 2.1.1 only – if the version you are downloading is different, this file name should be adjusted accordingly).

d.      After clicking on rw2011.exe you will be prompted to save the installation package to your local disk.  Click Save then choose a folder to place it in.

e.       Once it is finished saving, click Close,

2.      Once you have an installation package (e.g. rw2011.exe), use My Computer or Windows Explorer to go to the folder in which you save the R installation package.  Start the installation process by double clicking on the icon that corresponds to the installation package.

3.      In the Setup – R for Windows Wizard, select the Setup Language and click OK, then click Next. 

a.       Review the license agreement and if you accept it, select the I accept the agreement option and then click Next.

b.      Select the location in which you want R installed, and then click Next. 

c.       On the Select Components page, click Next to accept the default settings.

d.      On the Select Start Menu Folder page, set the name you want to use for the folder that will be created on your start menu then click Next.

e.       On the Select Additional Tasks page, accept the default settings then click Next.  R will then be installed.

f.        Make a note of the directory into which R was installed (e.g. C:\Program Files\R\rw2011).  You will need this information later in your installation process. When the installation is complete, click Finish.

g.       Click Finish when the installation is complete.  If you wish to make sure the installation worked, find the R submenu on your Start Menu and choose R 2.1.1.  If the application RGui comes up, it is working properly.  Close the RGui application – EmisView does not use the RGui, instead it calls R “behind the scenes”.

2. Installation of EmisView

An installer has been developed for EmisView to streamline the download and installation process.  The installer will download all needed EmisView files and set up your runemisview.bat and user_preferences.txt files for you automatically. It also supports updating EmisView as new versions become available.

2.1 Installing EmisView for the First Time

  1. Download the installer from the Downloads section of http://emisview.sourceforge.net. There are Windows executable and executable JAR file versions of the installer.  The executable Jar file version will work on any operating system for which Java is installed, but has only been tested on Linux.
  2. Once you have downloaded the installer, on the emvwinst.exe or emvwinst.jar to run the installer. It may take a few seconds to start. If the installer does not work, make sure that you can type “java –version” and it returns the version of Java you are using.  If this does not work, follow the steps appropriate to your operating system to make sure that Java is on your path.  The Windows installer for Java should have taken care of this for you.
  3. On the first page of the installer, you select the directories that EmisView needs to know about.  These include:

a.       The EmisView Download URL, which specifies where to download EmisView from.  Typically this is set to http://emisview.sourceforge.net/install.

b.      The EmisView Home Directory is the directory into which you want to install EmisView. Common locations to select on Windows are D:\emisview or C:\Program Files\emisview.

c.       The R Bin Directory is the bin directory for the R software package, which should already be installed. On Windows this is typically a directory like C:\Program Files\R\rw2011\bin.

d.      The Java 1.4 Bin Directory is the bin directory for the Java 1.4 package.  On Windows, this is typically a directory like C:\Program Files\Java\j2re1.4.2_09\bin.

  1. On the second page of the installer, you specify information about the database you are using. This includes a choice MySQL or PostgreSQL, for the database, and the Database Username, Database Password, Database Host and Database Port. It is important that the parameters you choose here match the configuration of your database server, otherwise EmisView will not be able to connect to the server

a.       Be sure to enter a valid username and password for your database server.

b.      If you are using a local MySQL database, the typical host is localhost ,and the port is 3306.

c.       If you are using a PostgreSQL database, the host may be localhost or a database server. A typical port to choose is 5432.

  1. On the third page of the installer, you specify information about the databases (MySQL) or database schemas (PostgreSQL) to create. EmisView stores three types of information: Emissions data, information about analyses, and reference information.  

a.       With MySQL, the three types of information are stored in different databases.  

                                       i.      MySQL users can usually keep the default settings for these databases (emissions, analysis, and reference).

                                     ii.      For MySQL, if the selected databases do not exist, EmisView will create them when it starts.

b.      With PostgreSQL, the three types of information are stored as different schemas within the same database.  Therefore, on this installer page, you must choose the name of the database that contains the schemas, as well as the names of the schemas to create.  Note that for PostgreSQL EmisView assumes that the selected Emissions database already exists, but it will create the schemas within the database if they do not exist.

                                       i.      If you do not have any emissions data already loaded, you can specify a database name for EmisView to use, but then you will need to go create it with PostgreSQL.  You should be able to accept the default names for the schemas (i.e., analysis, emissions, and reference).

                                     ii.      If you wish to use previously loaded emissions data (e.g. from CONCEPT), be sure to specify the name of the database that contains that data. You should then specify the name of the schema that contains your CONCEPT emissions data.  You should be able to accept the default names for the analysis and reference schemas.

c.       Once you have set all of your settings, click the Install button.  The installer will then download all of the EmisView files and create the runemisview.bat or runemisview.sh files, along with saving the user_preferences.txt file that is used by EmisView to obtain the names of the databases and other information about the system.

d.      The installer will notify you when the installation is complete.  A set of example data will be included with the downloads.  To start EmisView, go to the EmisView Home Directory, then into the bin directory, and double click on runEmisView.bat (Windows) or runEmisView.sh (Linux). 

e.       While you are in the bin directory, Windows users may create a shortcut for running EmisView by right clicking on runEmisView.bat and choose Send To->Desktop. For instructions on getting started using EmisView, proceed to the Getting Started section of the documentation.

f.        Note that in the bin directory under the EmisView Home Directory, there is a user_preferences.txt file.  It contains information about the databases / schemas used.  It also contains the lines format.double.significant_digits and format.double.decimal_places.  These are used to configure the precision of the numbers shown in the EmisView outputs. So, if you prefer more precision, you may wish to adjust these numbers later.

g.       Please submit bug reports or requests for enhancement (RFEs) to http://emisview.sourceforge.net.

2.2 Updating Your EmisView Installation

  1. To update your EmisView installation, run the installer.  It will come up using the settings from the previous run of the installer.
  2. On the first page of the installer, if you select a new EmisView Home Directory, a new installation of EmisView will be created.  Be aware that if you keep the default names for the databases or schemas, the new version of EmisView will point to the same schemas / databases as the first time.  To use new databases, you need to specify different names than you did the first time.
  3. On the first page of the installer, if you select the same EmisView Home Directory as you did the first time, the installer will prompt you whether to Reinstall or Update your installation.  If you select Reinstall, the installer will download a whole new set of files and will overwrite your current installation.  For this case, the same steps will follow as did for the first time installation.
  4. If you select Update, the install will download only the files that have been updated since your last EmisView update or installation. Once you click Update, a fourth page of the installer will appear and will show you which files will be updated.  You may cancel the installation by clicking Cancel, or proceed by clicking OK.  Once the update is complete, click Exit to exit the installer.
  5. Note that when you Update your installation, the user_preferences.txt and runEmisView.bat or runEmisView.sh files will be recreated with your newly specified settings.