<commit_before>## InSitu Data Viewer ##

### Goal ###

Provide a Data Viewer based on Web technologies and relying on the user browser
to navigate and explore data generated InSitu or in batch mode.

## Installation

```
$ npm install -g in-situ-data-viewer
```

After installing the package you will get 2 executable with the following set of
options.

```
$ InSituDataViewer

  Usage: InSituDataViewer [options]

  Options:

    -h, --help                   output usage information
    -V, --version                output the version number
    -p, --port [3000]            Start web server with given port
    -d, --data [directory/http]  Data directory to serve. Should contain a info.json file.
    -s, --server-only            Do not open the web browser
```


```
$ InSituDataDownloader

  Usage: InSituDataDownloader [options]

  Options:

    -h, --help                                output usage information
    -V, --version                             output the version number
    -s, --download-sample-data                Download some try-out data [~100MB]
    -d, --download [http://remote-host/data]  Url to the source of your in-situ data.
    -o, --output [directory]                  Data directory where to download remote data locally
```

In order to try it out, you should download some sample dataset
(unless you already have some ;-) and run the data viewer on them.

Here is an example on how to download some sample data

```
$ InSituDataDownloader -s -o ./tonic-data

 | Downloading sample data (~100MB) into directory /Users/seb/tonic-data
 |
 | => Once the data will be downloaded, you will be able to try the InSituDataViewer with the following commands:
 |
 |  $ InSituDataViewer -d /.../tonic-data/mpas-probe-flat-earth
 |  $ InSituDataViewer -d /.../tonic-data/hydra-image-fluid-velocity
 |
 | Thank you for trying this out... Seb
```

Then you can load them using the provided feedback or by running the following
command lines:

```
$ InSituDataViewer -d ./tonic-data/mpas-probe-flat-earth
```

This will load a MPAS oceanic simulation data that represent a 3D volume of a
flatten version of the earth with Temperature and Salinity information of the water.

From that data you can look at a slice of the data along any axis and move the
slice back and forth using the scroll of your input device.

If you want to zoom or pan, you will have to scroll+[any modifier key] or drag+[any modifier key].

```
$ InSituDataViewer -d ./tonic-data/hydra-image-fluid-velocity
```

This will load an Hydra CFD simulation data that represent the fluid velocity
using some volume rendering technique.


#### Licensing

**InSituDataViewer** is licensed under [BSD Clause 3](LICENSE).

#### Getting Involved

Fork our repository and do great things. At [Kitware](http://www.kitware.com),
we've been contributing to open-source software for 15 years and counting, and
want to make **InSituDataViewer** useful to as many people as possible.
<commit_msg>Improve readme<commit_after>## InSitu Data Viewer ##

### Goal ###

Provide a Data Viewer based on Web technologies and relying on the user browser
to navigate and explore data generated InSitu or in batch mode.

## Installation

```
$ npm install -g in-situ-data-viewer
```

After installing the package you will get 2 executable
[**InSituDataViewer**, **InSituDataDownloader**] with the following set of
options.

```
$ InSituDataViewer

  Usage: InSituDataViewer [options]

  Options:

    -h, --help                   output usage information
    -V, --version                output the version number
    -p, --port [3000]            Start web server with given port
    -d, --data [directory/http]  Data directory to serve. Should contain a info.json file.
    -s, --server-only            Do not open the web browser
```


```
$ InSituDataDownloader

  Usage: InSituDataDownloader [options]

  Options:

    -h, --help                                output usage information
    -V, --version                             output the version number
    -s, --download-sample-data                Download some try-out data [~100MB]
    -d, --download [http://remote-host/data]  Url to the source of your in-situ data.
    -o, --output [directory]                  Data directory where to download remote data locally
```

In order to try it out, you should download some sample datasets
(unless you already have some ;-) and run the data viewer on them.

Here is an example on how to download some sample data

```
$ InSituDataDownloader -s -o ./tonic-data

 | Downloading sample data (~100MB) into directory /Users/seb/tonic-data
 |
 | => Once the data will be downloaded, you will be able to try the InSituDataViewer with the following commands:
 |
 |  $ InSituDataViewer -d /Users/seb/tonic-data/mpas-probe-flat-earth
 |  $ InSituDataViewer -d /Users/seb/tonic-data/hydra-image-fluid-velocity
 |
 | Thank you for trying this out... Seb
```

Then you can load them using the provided feedback or by running the following
command lines:

```
$ InSituDataViewer -d ./tonic-data/mpas-probe-flat-earth
```

This will load a MPAS oceanic simulation data that represent a 3D volume of a
flatten version of the earth with Temperature and Salinity information on the water.

From that data you can look at a slice of the data along any axis and move the
slice back and forth using the scroll of your input device.

If you want to zoom or pan, you will have to scroll+[any modifier key] or drag+[any modifier key].

```
$ InSituDataViewer -d ./tonic-data/hydra-image-fluid-velocity
```

This will load an Hydra CFD simulation data that represent the fluid velocity
using some volume rendering technique.


#### Licensing

**in-situ-data-viewer** is licensed under [BSD Clause 3](LICENSE).

#### Getting Involved

Fork our repository and do great things. At [Kitware](http://www.kitware.com),
we've been contributing to open-source software for 15 years and counting, and
want to make **in-situ-data-viewer** useful to as many people as possible.

{'fraction_non_alphanumeric': 0.0879175668938009, 'fraction_numerical': 0.0049858733588166865, 'mean_word_length': 2.9436435124508518, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 23, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '548255', 'n_tokens_mistral': 1812, 'n_tokens_neox': 1677, 'n_words': 751}