<commit_before># NuPIC Developer Tools

I keep scripts I use for NuPIC development here. More details at some point.

## Assumptions

- You have `git` installed.
- You have the `NUPIC` environment variable set to the path of your NuPIC checkout.
- You have the `NUPIC_CORE` environment variable set to the path of your `nupic.core` checkout.
- You are a NuPIC committer (you have push access), required for releasing.

## Installation

Add the `bin` folder to your `PATH`.
<commit_msg>Added usage instructions to README.<commit_after># NuPIC Developer Tools

I keep scripts I use for NuPIC development here. More details at some point.

## Assumptions

- You have `git` installed.
- You have the `NUPIC` environment variable set to the path of your NuPIC checkout.
- You have the `NUPIC_CORE` environment variable set to the path of your `nupic.core` checkout.
- You are a NuPIC committer (you have push access), required for releasing.

## Installation

Add the `bin` folder to your `PATH`.

## Usage

### Installing NuPIC Core

Call the `install_core` script.

```
Installs nupic.core from /Users/mtaylor/nta/nupic.core directory. By default, this
installs into /Users/mtaylor/nta/nupic.core/build/release, but can be overridden with the
-r or -s options (see below).

Usage:
> install_nupic_core [options]

Options:
 -c Clean build, removes old build artifacts.
 -v Verbose console output.
 -s build into system location (if specified, -r is ignored)
 -r <release-dir> outputs release to specified directory instead of
    /Users/mtaylor/nta/nupic.core/build/release (default)

Examples:
An installation to default location at /Users/mtaylor/nta/nupic.core/build/release:
    > install_nupic_core
A clean verbose installation to system location:
    > install_nupic_core -cvs
A clean installation to specified location (/tmp):
    > install_nupic_core -c -r /tmp
```

### Installing NuPIC

Call the `install_nupic` script.

```
Installs NuPIC from /Users/mtaylor/nta/nupic directory. If nupic.core release directory
is not specified with -u or -r options (see below), the nupic.core
binary package is downloaded.

Usage:
> install_nupic [options]

Options:
 -c Clean build, removes old build artifacts.
 -v Verbose console output.
 -u Builds using nupic.core release at /Users/mtaylor/nta/nupic.core/build/release
 -r <release-dir> Builds using nupic.core release at specified
    directory instead of /Users/mtaylor/nta/nupic.core/build/release.

Examples:
An installation using downloaded nupic.core binary release:
    > install_nupic
A clean verbose installation using nupic.core at
/Users/mtaylor/nta/nupic.core/build/release:
    > install_nupic -cvu
A clean installation using nupic.core at specified location (/tmp):
    > install_nupic -cv -r /tmp
```

### Install Both NuPIC and NuPIC Core

Call the `install_nupic_all` script, which calls the previous two scripts with the `-c` options and ensures the `nupic.core` release binaries are used for the `nupic` build. 
{'fraction_non_alphanumeric': 0.08428475486903962, 'fraction_numerical': 0.0, 'mean_word_length': 4.066326530612245, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1902252', 'n_tokens_mistral': 958, 'n_tokens_neox': 924, 'n_words': 371}