## Requirements¶

Installing Reveal Chromatography requires one of the following operating system (64-bit):

• Microsoft Windows 10
• Microsoft Windows 7
• Linux RedHat/Centos 5
• Linux Ubuntu 16.4
• OSX El Capitan

Note

By default, all of the application’s files will be installed in the home directory of the user. Therefore, there is no need for the user account to have administrative rights to install Reveal Chromatography.

On the hardware front, the following specifications are a minimum:

• 6GB of RAM
• 10GB of free hard drive space
• 1200x900 of screen resolution.

If you plan on using Reveal for real model calibration or process characterization/optimization work, the following configuration is recommended:

• 16 GB of RAM or more
• 4 CPU cores
• 200+ GB of free hard drive space
• Dual monitors with 1900x1200 pixels of resolution

For more details Reveal’s usage of resources and how to evaluate needs, refer to the user manual’s dedicated section: Large-scale computations with Reveal.

The latest version released of Reveal Chromatography is version 1.0.0. It was released on March 18th 2018 and a 1-click installer for Windows can be downloaded from here. Contact us if you need a Linux and OSX installers (license holders only).

This version is fully backward-compatible in addition to containing lots of new features, improvements and bug fixes (see the changelog). All users should upgrade.

Note that the release has also been published as an in-app update, available to all existing users with version 0.8.0 and above. For more details about the Application Updater, see Updating the Reveal application.

## Installing Reveal Chromatography¶

### Windows¶

If users already have an older version of Reveal Chromatography installed, we recommend that users uninstall it first. For instructions on how to uninstall Reveal, see the Uninstalling Reveal Chromatography section below.

To install Reveal Chromatography, download the latest 1-click installer (above), then double-click on the .msi file. On some Windows 10 installations, a window may pop up warning about the installer not being recognized. To launch the installer, please click on More info:

and then on Run anyway:

Once the installer is running, follow its instructions and let it unpack the application:

### Other platforms¶

OSX and Linux platform installers come in the form of a single .tar.gz file. Once downloaded, unpack the file into the reveal_chromatography folder. Then, refer to the INSTALL.txt file for instructions, and README.txt for more details. No dependencies are required for installation.

To preserve performances, Linux and OSX installers don’t come with a pre-compiled version of CADET, but only the source code of our custom pH-enabled version (official CADET 2.3.2 also supported). The CADET install instructions should then be followed and we provide support for all license holders.

Once a version of CADET is installed, launch Reveal Chromatography, and edit the preferences (Edit > Preferences) to point to the desired cadet-cs executable (solver tab).

## Launching Reveal Chromatography¶

### Windows¶

The default installation creates shortcuts to the application launchers (there are two) in the top section of the start menu, as well as a Reveal-Chromatography folder in the program list of the start menu. This is also where users can find the application’s un-installer.

Reveal Chromatography app launchers in the Windows 7 start menu.

Reveal Chromatography app launchers in the Windows 10 start menu.

Both launchers run the same version of the application. The only difference is that the debug version displays some details of the applications’s execution progress in a command prompt console.

Once the software has been successfully installed, we recommend that users walk through the Getting Started guide to learn about using the core features of Reveal Chromatography.

### Other platforms¶

To launch the application, the reveal-chrom executable must be launched at the command line. It is recommended to add alias to that file to make it recognizable form anywhere. On bash environments, that means editing the ~/.bashrc (Linux) or ~/.bash_profile (OSX) and adding the following line:

alias reveal-chrom=<YOU_PATH_TO>/reveal_chromatography/bin/reveal-chrom


One should avoid adding the whole reveal_chromatography/bin folder to the PATH environment variable, as that might lead to modifying the environment Reveal needs to run (it is a self-contained Python environment).

## Uninstalling Reveal Chromatography¶

### Windows¶

To uninstall Reveal Chromatography follow only step 1. To remove all traces of the software, including the license file, the user data and more, follow all steps listed below:

1. Click the start menu, navigate to the All Programs section. In the Reveal-Chromatography folder, select Uninstall Reveal-Chromatography and follow the instructions of the uninstaller.
2. Reboot Windows. Then, make sure that C:\Users\<USERNAME>\AppData\Local\Apps\Reveal-Chromatography does not exist any longer. To do this, open your Windows file explorer, and go to your home directory. To go into AppData, which is a hidden folder, you will then need to click in the path bar to type in AppData:

Then, navigate to Local to make sure no Apps\Reveal-Chromatography folder remains.

1. During the normal course of utilization, the application stores information (CADET input files, logs, user data content) in the application data folder located inside the hidden folder of your home folder C:\Users\<USERNAME>\AppData\Roaming.

To delete all Reveal Chromatography related files, open the Windows file explorer, navigate to your home directory, and in the path bar, add AppData to enter the hidden folder. Then, navigate to AppData > Roaming > Reveal and delete the entire Chromatography folder.

### Other platforms¶

On OSX and Linux environments, removing Reveal Chromatography means deleting the unpacked folder reveal_chromatography.

For a complete and more permanent removal, users will also need to remove any alias added to the bashrc/bash_profile and the ~/.reveal/chromatography folder should also be deleted. That will remove the preference file, and all stored user data (products, components, columns, ...).