<commit_before>### Perlin Noise
Library for generating Perlin Noise in Go.

    go get github.com/jasdel/perlinnoise

* Based on [Java](http://cs.nyu.edu/~perlin/noise/) implementation of the Improved Noise.
* Also based on https://github.com/sol-prog/Perlin_Noise for random permutation genration.


### Usage
    ./perlinnoise/main.go provides sample usage.

    // Create with seed which will generate permutations randomly from the seed
    p := perlinnoise.New(*seed)

    // Create with default permutation
    p := perlinnoise.NewDefault()

    // Noise returns the noise value in three dementional space
    pn.Noise(x, y, z)


### License
BSD 2 clause<commit_msg>added example usage to readme<commit_after>### Perlin Noise
Library for generating Perlin Noise in Go.

    go get github.com/jasdel/perlinnoise

* Based on [Java](http://cs.nyu.edu/~perlin/noise/) implementation of the Improved Noise.
* Also based on https://github.com/sol-prog/Perlin_Noise for random permutation genration.


### Usage
    ./perlinnoise/main.go provides sample usage.

    // Create with seed which will generate permutations randomly from the seed
    p := perlinnoise.New(*seed)

    // Create with default permutation
    p := perlinnoise.NewDefault()

    // Noise returns the noise value in three dementional space
    pn.Noise(x, y, z)


#### Example Executable
In the ./perlinnoise/ folder an example executable will print out the result of the noise.

The example takes thre options, h (height in rows), w (width in columns), and s seed for the noise.

    perlinnoise -h 20 -w 40 -s 10

    ~~~~~~~~..........~~~~~...........~~~~~.
    ~~~~~~~..,...~~~~~~~~~~...~~~~~...~~~~~.
    ~~~~~~~.,#,...~~~~~~.....~~~~~~..~~.,#,.
    ~~~~~~~~..~~~~~~~~~~..~~~~~~~~~~~~~,,,.~
    ,.~~~~~~.~~~~~~~~~~...~~~~~~~~.#,..,...,
    ..~~~~~,#,~~~~~~~~~~~~~~~~~~~~~..,,,,...
    ..~~~~~...~~~~.,.~~~~~~.......~.,#,...~.
    ..~~~...~~~~~~~.~~~~~~~.~~~.....,,.~~~~~
    .~~.,##,.~~~~~~~~~~~~~~~~~~~.,..,,.~~~~.
    .~~..,..~~~~~~~~~~~~~~~~~~~...~~..~~~~~~
    ~~~.....,#,.......~~~~~~~~.,,~~~~~~~~~~~
    ~~~~~~~~.,,,..~~~~~~~~~~~~~...~~~~~~~~~~
    ~~~~~~~~~~~~~~~~~~~......~~~..~~~~~~~~~~
    ~~~~~~~~~~~~~~~~~~~...~~~~~~..~~~~~~~~~~
    ~~.,.~~~.###..~...~~~~~..~~~~~~~~~~...~~
    ~.###,,,###,..~~~~~~~~~~~~~~~~~~~~~~~~~~
    .,,......~~~.,,...,,..~~~~~~..~~~~~~,#.~
    ..~~~~~~~~~~....~~~....~~~~~~~~~~~~,##,~
    .~~~.~~~~~~~~~~~~~~~.,.~~~~~~~~~~~~~..~~
    ,.~~~~~~~~~~~~~~~~~~...~~~~....~~~~~~~~~


### License
BSD 2 clause
{'fraction_non_alphanumeric': 0.3790771678599841, 'fraction_numerical': 0.0031821797931583136, 'mean_word_length': 2.720414201183432, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2512333', 'n_tokens_mistral': 837, 'n_tokens_neox': 736, 'n_words': 184}