<commit_before># CDJSVis README file

This file is aimed at people wanting to run the code from source. If you are running a prebuilt '.app' application then the only section that concerns you is the [Other software](http://magrid-server-5.lut.ac.uk/macdjs/CDJSVis/tree/master#other-software) section below.

## Requirements

This code requires [Python 2.7](http://www.python.org/download/releases/2.7/) to run.  It depends on a number of Python modules/libraries and also some other programmes.

### Python modules

This is a list of third-party python modules that this code requires to run.  They can be installed in a variety of ways, such as with [MacPorts](http://www.macports.org/), [pip](https://pypi.python.org/pypi/pip), [apt-get](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) or similar.

Required:

* [NumPy](http://www.numpy.org/)
* [SciPy](http://www.scipy.org/)
* [Matplotlib](http://matplotlib.org/)
* [PySide](https://pypi.python.org/pypi/PySide) (including 'pyside-rcc' (commonly included in 'pyside-tools' or similar))
* [Pillow](https://pillow.readthedocs.org/)
* [VTK](http://www.vtk.org/) (with the Python bindings enabled)
* [Sphinx](http://sphinx-doc.org/)
* [nose](https://nose.readthedocs.org/en/latest/) (testing)

Optional:

* [Paramiko](http://www.paramiko.org/) - for loading files via the SFTP file browser
* [pyhull](http://pythonhosted.org/pyhull/) - for computing facet areas of convex hulls

### Other libraries

This code also requires the following libraries to be installed:

* [GSL](http://www.gnu.org/software/gsl/) - GNU Scientific Library

### Other software

In order to be able to use all features the following programmes should be installed:

*   [POV-Ray](http://www.povray.org/) (for offline rendering of images; looks better)
*   [Ffmpeg](https://www.ffmpeg.org/) (for creating movies; sequencer and rotator)

If these are not installed in default system locations you can set the paths to where they are installed in the preferences dialog.

## Installation

You can either build the code in-place or install it into the Python site-packages directory, for example within a [virtualenv](http://virtualenv.readthedocs.org/en/latest/).

### Installing to Python site-packages

Build the documentation (includes inplace build of extensions):

```
python setup.py build_sphinx
```

and verify the tests run with no errors:

```
python setup.py test
```

Then run:

```
python setup.py build
python setup.py install
```

If you are not using a virtual environment you may need to `sudo` the last (install) command.

### In-place build

Build the documentation (includes inplace build of extensions):

```
python setup.py build_sphinx
```

and verify the tests run with no errors:

```
python setup.py test
```

Then you can add the `/path/to/CDJSVis` directory to you PYTHONPATH and PATH and run cdjsvis.py from anywhere.

## Building application (Mac OS X)

On Mac OS X you can build a .app application using [PyInstaller](http://www.pyinstaller.org/). Simply change to the pyinstaller/ directory and run `./build.sh` (you may need to edit the path to pyinstaller.py).
<commit_msg>Update readme file<commit_after># CDJSVis README file

This file is aimed at people wanting to run the code from source. If you are running a prebuilt '.app' application then the only section that concerns you is the [Other software](http://magrid-server-5.lut.ac.uk/macdjs/CDJSVis/tree/master#other-software) section below.

## Requirements

This code requires [Python 2.7](http://www.python.org/download/releases/2.7/) to run.  It depends on a number of Python modules/libraries and also some other programmes.

### Python modules

This is a list of third-party python modules that this code requires to run.  They can be installed in a variety of ways, such as with [MacPorts](http://www.macports.org/), [pip](https://pypi.python.org/pypi/pip), [apt-get](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) or similar.

Required:

* [NumPy](http://www.numpy.org/)
* [SciPy](http://www.scipy.org/)
* [Matplotlib](http://matplotlib.org/)
* [PySide](https://pypi.python.org/pypi/PySide)
* [Pillow](https://pillow.readthedocs.org/)
* [VTK](http://www.vtk.org/) (with the Python bindings enabled)
* [Sphinx](http://sphinx-doc.org/)
* [nose](https://nose.readthedocs.org/en/latest/) (testing)

Optional:

* [Paramiko](http://www.paramiko.org/) - for loading files via the SFTP file browser
* [pyhull](http://pythonhosted.org/pyhull/) - for computing facet areas of convex hulls

### Other libraries

This code also requires the following libraries to be installed:

* [GSL](http://www.gnu.org/software/gsl/) - GNU Scientific Library

### Other software

In order to be able to use all features the following programmes should be installed:

*   [POV-Ray](http://www.povray.org/) (for offline rendering of images; looks better)
*   [Ffmpeg](https://www.ffmpeg.org/) (for creating movies; sequencer and rotator)

If these are not installed in default system locations you can set the paths to where they are installed in the preferences dialog.

## Installation

You can either build the code in-place or install it into the Python site-packages directory, for example within a [virtualenv](http://virtualenv.readthedocs.org/en/latest/).

In both cases you should first copy the config file: `cp setup.cfg.example setup.cfg` and add/edit any relevant sections. Normally this file can be left as is.

### In-place build

Build the documentation (includes inplace build of extensions):

```
python setup.py build_sphinx
```

and verify the tests run with no errors:

```
python setup.py test
```

Then you can add the `/path/to/CDJSVis` directory to you PYTHONPATH and PATH and run cdjsvis.py from anywhere.

### Installing to Python site-packages

Build the documentation (includes inplace build of extensions):

```
python setup.py build_sphinx
```

and verify the tests run with no errors:

```
python setup.py test
```

Then run:

```
python setup.py build
python setup.py install
```

If you are not using a virtual environment you may need to `sudo` the last (install) command.

## Building application (Mac OS X)

On Mac OS X you can build a .app application using [PyInstaller](http://www.pyinstaller.org/). Simply change to the pyinstaller/ directory and run `./build.sh` (you may need to edit the path to pyinstaller.py).

{'fraction_non_alphanumeric': 0.11930210625589437, 'fraction_numerical': 0.0015718327569946558, 'mean_word_length': 4.293677204658902, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 20, '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': '4680717', 'n_tokens_mistral': 1997, 'n_tokens_neox': 1921, 'n_words': 724}