<commit_before># Downloading Iris

#### <a name="toc"></a> Table of Contents
--------

-   **[Quickstart](#quickstart)**
-   **[Detailed Download Instructions](#details)**
    -   [Download and Install Iris](#download)
    -   [Run Iris](#run) 
    -   [Run Smoke Test](#test)
    -   [For C-Shell Users](#cshell)

-----------------------------------------------------------------------

<!-- TODO: highlight this area -->
Iris 3.0b1: released August 2015 
This version of Iris is a beta release. Please see the latest Release Notes for details on the new features, bug fixes, and currently known bugs and limitations. If you find any bugs or have suggestions, please contact us at the [CXC HelpDesk](/helpdesk) with the tag "Iris."
<!-- end highlight section -->

The Iris software package is available for download through Anaconda. Iris is supported on Linux and Macintosh OS X 10.6 - 10.11 computer platforms running Java version 1.6 or higher.

*If you are running Mac OS X 10.5 with Java 1.5, please follow the special
 installation instructions available [here][macosx105].*

-----------------------------------------------------------------------

### <a name="sysreqs"></a> Iris system requirements

Iris will not run on a system which does not have at least Java SE 6 (developer version 1.6), preferably Oracle JRE, though special installation instructions are available for the Mac OS X 10.5 platform running Java 1.5.

To check your current Java version, type `java -version` into a terminal window:

	unix% java -version
	java version "1.8.0_40"
	Java(TM) SE Runtime Environment (build 1.8.0_40-b27)
	Java HotSpot(TM) 64-Bit Server VM (build 25.40-b25, mixed mode)
      
Free disk space:

  * OS X: ~220 MB
  * Linux 64-bit: ~370 MB
  * Linux 32-bit: ~330 MB
  
<!--
The Specview and Sherpa applications which comprise Iris run simultaneously and
communicate with each other via a SAMP hub.
-->

Known issues with installing and starting Iris are listed on the [Troubleshooting page][download_trouble].

## <a name="quickstart"></a> Download Iris QuickStart

These instructions tell you how to download and install Iris quickly. For more details, tips-and-tricks and some troubleshooting, read the full direction starting in [Detailed Download Directions](#details).

### Download and Installation Instructions:

These directions assume you are running in a BASH shell. If you are running a C-shell (csh, tcsh), then start a BASH shell:

	$ /bin/bash  # for C-shell users ONLY
    
  - If you do not have Anaconda, download Miniconda (a minimal version of Anaconda) for your platform. Otherwise, skip to step 2.

	  * [OS X (64-bit)][conda_osx]
	  * [Linux 64-bit][conda_l64]
	  * [Linux 32-bit][conda_l32]
  
  - Install Miniconda. Installing Miniconda in batch mode assumes the user agrees with the end user [license agreement][conda_license].

		$ bash Miniconda-latest-Linux-x86_64.sh -b -p $HOME/miniconda
		$ export PATH=$PATH:$HOME/miniconda/bin
      
  - Add `$ export PATH=$PATH:$HOME/miniconda/bin` to your `$HOME/.bashrc` or `$HOME/.bash_profile` so that you can run Anaconda commands from your terminal at any time. For example:

		$ emacs ~/.bashrc
		
		export PATH=$PATH:$HOME/miniconda/bin

    Otherwise, you will need to run `$ export PATH=$PATH:$HOME/miniconda/bin`
    each time before you run Iris.
      
  - Add the CXC and Sherpa conda repositories to your Anaconda configuration:
  
		$ conda config --add channels https://conda.anaconda.org/cxc
		$ conda config --add channels https://conda.anaconda.org/sherpa
      
  - Install Iris. This will create a environment specific to Iris. Say yes (enter "y") when the download script asks you to install the packages.
		$ conda create -n iris iris=3.0b1

    If you have an environment named `iris` already, you can either rename your
    old environment (with, for example, `mv $HOME/miniconda/envs/iris
    $HOME/miniconda/envs/iris2.1`), give this new Iris installation a new
    enviornment name (with `conda create -n iris30b1 iris=3.0b1`), or delete
    your old Iris installation entirely (with `rm -rf
    $HOME/miniconda/envs/iris`).
    
  - Start Iris. Activate the Iris environment first. Then, you can run Iris as you would for previous versions.
  
		$ source activate iris
		$ iris
    
    __IMPORTANT:__ If you have set "iris" as an alias in your `$HOME/.bashrc` or `$HOME/.bash_profile` to run an older version of Iris, please rename the old alias to something else (for example, "iris201" for Iris v2.0.1).

  - Run the Iris smoke tests to confirm that Iris was installed successfully:
  
		$ iris smoketest<commit_msg>Fix markup error.<commit_after># Downloading Iris

#### <a name="toc"></a> Table of Contents
--------

-   **[Quickstart](#quickstart)**
-   **[Detailed Download Instructions](#details)**
    -   [Download and Install Iris](#download)
    -   [Run Iris](#run) 
    -   [Run Smoke Test](#test)
    -   [For C-Shell Users](#cshell)

-----------------------------------------------------------------------

<!-- TODO: highlight this area -->
Iris 3.0b1: released August 2015 
This version of Iris is a beta release. Please see the latest Release Notes for details on the new features, bug fixes, and currently known bugs and limitations. If you find any bugs or have suggestions, please contact us at the [CXC HelpDesk](/helpdesk) with the tag "Iris."
<!-- end highlight section -->

The Iris software package is available for download through Anaconda. Iris is supported on Linux and Macintosh OS X 10.6 - 10.11 computer platforms running Java version 1.6 or higher.

*If you are running Mac OS X 10.5 with Java 1.5, please follow the special
 installation instructions available [here][macosx105].*

-----------------------------------------------------------------------

### <a name="sysreqs"></a> Iris system requirements

Iris will not run on a system which does not have at least Java SE 6 (developer version 1.6), preferably Oracle JRE, though special installation instructions are available for the Mac OS X 10.5 platform running Java 1.5.

To check your current Java version, type `java -version` into a terminal window:

	unix% java -version
	java version "1.8.0_40"
	Java(TM) SE Runtime Environment (build 1.8.0_40-b27)
	Java HotSpot(TM) 64-Bit Server VM (build 25.40-b25, mixed mode)
      
Free disk space:

  * OS X: ~220 MB
  * Linux 64-bit: ~370 MB
  * Linux 32-bit: ~330 MB
  
<!--
The Specview and Sherpa applications which comprise Iris run simultaneously and
communicate with each other via a SAMP hub.
-->

Known issues with installing and starting Iris are listed on the [Troubleshooting page][download_trouble].

## <a name="quickstart"></a> Download Iris QuickStart

These instructions tell you how to download and install Iris quickly. For more details, tips-and-tricks and some troubleshooting, read the full direction starting in [Detailed Download Directions](#details).

### Download and Installation Instructions:

These directions assume you are running in a BASH shell. If you are running a C-shell (csh, tcsh), then start a BASH shell:

	$ /bin/bash  # for C-shell users ONLY
    
  - If you do not have Anaconda, download Miniconda (a minimal version of Anaconda) for your platform. Otherwise, skip to step 2.

	  * [OS X (64-bit)][conda_osx]
	  * [Linux 64-bit][conda_l64]
	  * [Linux 32-bit][conda_l32]
  
  - Install Miniconda. Installing Miniconda in batch mode assumes the user agrees with the end user [license agreement][conda_license].

		$ bash Miniconda-latest-Linux-x86_64.sh -b -p $HOME/miniconda
		$ export PATH=$PATH:$HOME/miniconda/bin
      
  - Add `$ export PATH=$PATH:$HOME/miniconda/bin` to your `$HOME/.bashrc` or `$HOME/.bash_profile` so that you can run Anaconda commands from your terminal at any time. For example:

		$ emacs ~/.bashrc
		
		export PATH=$PATH:$HOME/miniconda/bin

    Otherwise, you will need to run `$ export PATH=$PATH:$HOME/miniconda/bin`
    each time before you run Iris.
      
  - Add the CXC and Sherpa conda repositories to your Anaconda configuration:
  
		$ conda config --add channels https://conda.anaconda.org/cxc
		$ conda config --add channels https://conda.anaconda.org/sherpa
      
  - Install Iris. This will create a environment specific to Iris. Say yes (enter "y") when the download script asks you to install the packages.

		$ conda create -n iris iris=3.0b1

    If you have an environment named `iris` already, you can either rename your
    old environment (with, for example, `mv $HOME/miniconda/envs/iris
    $HOME/miniconda/envs/iris2.1`), give this new Iris installation a new
    enviornment name (with `conda create -n iris30b1 iris=3.0b1`), or delete
    your old Iris installation entirely (with `rm -rf
    $HOME/miniconda/envs/iris`).
    
  - Start Iris. Activate the Iris environment first. Then, you can run Iris as you would for previous versions.
  
		$ source activate iris
		$ iris
    
    __IMPORTANT:__ If you have set "iris" as an alias in your `$HOME/.bashrc` or `$HOME/.bash_profile` to run an older version of Iris, please rename the old alias to something else (for example, "iris201" for Iris v2.0.1).

  - Run the Iris smoke tests to confirm that Iris was installed successfully:
  
		$ iris smoketest
{'fraction_non_alphanumeric': 0.12071760510104831, 'fraction_numerical': 0.020966173133037933, 'mean_word_length': 3.103769401330377, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 24, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '90274', 'n_tokens_mistral': 2949, 'n_tokens_neox': 2704, 'n_words': 1161}