<commit_before>
This file documents how to install and run the gcf package, including
the Omni command-line tool.

See README.txt for details on the usage of the gcf package, and
README-omni.txt for details on Omni.

Omni users should follow these install instructions to ensure software dependencies are met.

Upgrading? For upgrading instructions look at the end of this file.

{{{
!#comment
The rest of the page is wiki formatted.
Content should mirror wiki:QuickStart
Section that is different is Section 3
}}}

== 1. Create the gcf directory ==

      * If you have downloaded the software from the git repository, you can skip this step.
      {{{
      tar xvfz gcf-2.2.1.tar.gz
      }}}
      * Move the gcf directory to the directory where you want to permanently keep gcf. This might be your home directory. [[BR]]If you have `sudo` privileges in your host, you might want to consider moving the gcf package under `/usr/local/bin/` for a cleaner setup. 
      {{{
      [sudo] mv gcf-2.2.1 <install-dir>
      }}}
      * Create a symbolic link  called `gcf` to your installation directory. This will make the process of upgrading omni easier.
      {{{
      cd <install-dir>
      rm gcf; ln -s gcf-2.2.1 gcf
      }}}

==  2. Add GCF to your path == 

In order to be able to run omni.py, gcf-am.py and any of the scripts
(e.g. readyToLogin.py) you will need to modify the `PATH` and the
`PYTHONPATH` environment variables. 

It is recommended that you make these modifications in a configuration file so that they are set every
time you login to your host.  The name of the configuration file is
dependent on the shell you are running. 

In order to figure out which shell you are using run:
{{{
 ps -p $$
}}}

If you are using a bash shell, copy and paste these lines to the end
of your `.bashrc` file. This file is located in your home
directory. If the file does not exist, you can create it. 
If you are using a different shell, then modify these lines appropriately and add
them to the configuration file of your shell. Make sure to replace
`<PATH-TO-GCF-DIR>` with the actual path to your gcf directory. For<commit_msg>Update version to 2.3.2 in INSTALL.txt<commit_after>
This file documents how to install and run the gcf package, including
the Omni command-line tool.

See README.txt for details on the usage of the gcf package, and
README-omni.txt for details on Omni.

Omni users should follow these install instructions to ensure software dependencies are met.

Upgrading? For upgrading instructions look at the end of this file.

{{{
!#comment
The rest of the page is wiki formatted.
Content should mirror wiki:QuickStart
Section that is different is Section 3
}}}

== 1. Create the gcf directory ==

      * If you have downloaded the software from the git repository, you can skip this step.
      {{{
      tar xvfz gcf-2.3.2.tar.gz
      }}}
      * Move the gcf directory to the directory where you want to permanently keep gcf. This might be your home directory. [[BR]]If you have `sudo` privileges in your host, you might want to consider moving the gcf package under `/usr/local/bin/` for a cleaner setup. 
      {{{
      [sudo] mv gcf-2.3.2 <install-dir>
      }}}
      * Create a symbolic link  called `gcf` to your installation directory. This will make the process of upgrading omni easier.
      {{{
      cd <install-dir>
      rm gcf; ln -s gcf-2.3.2 gcf
      }}}

==  2. Add GCF to your path == 

In order to be able to run omni.py, gcf-am.py and any of the scripts
(e.g. readyToLogin.py) you will need to modify the `PATH` and the
`PYTHONPATH` environment variables. 

It is recommended that you make these modifications in a configuration file so that they are set every
time you login to your host.  The name of the configuration file is
dependent on the shell you are running. 

In order to figure out which shell you are using run:
{{{
 ps -p $$
}}}

If you are using a bash shell, copy and paste these lines to the end
of your `.bashrc` file. This file is located in your home
directory. If the file does not exist, you can create it. 
If you are using a different shell, then modify these lines appropriately and add
them to the configuration file of your shell. Make sure to replace
`<PATH-TO-GCF-DIR>` with the actual path to your gcf directory. For
{'fraction_non_alphanumeric': 0.06669765280037183, 'fraction_numerical': 0.006274692075296305, 'mean_word_length': 3.248766041461007, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4372526', 'n_tokens_mistral': 1255, 'n_tokens_neox': 1195, 'n_words': 670}