# tovtk

**Repository Path**: shzhou_admin/tovtk

## Basic Information

- **Project Name**: tovtk
- **Description**: Python meshtal -> VTK converter
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-03
- **Last Updated**: 2020-12-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/inr-kit/tovtk.svg?branch=master)](https://travis-ci.org/inr-kit/tovtk)

# tovtk
The package provides the `tovtk` command line tool to convert MCNP5 and MCNP6 meshtal viles to VTK format.

The output vtk files contain a rectilinear grid with cell values.

## Limitations
Only rectangular meshtally. 

In case `emesh` is used to split into energy bins, the resulting vtk file
contains values only from the total bin.

## Invocation

```bash
# Using the wrapper script:
>tovtk meshtal
# Using Python directly:
>pyhton -m tovtk meshtal
```

## Installation
Get source from the github:
```bash
>mkdir tovtk-git
>cd tovtk-git
>git clone git@github.com:inr-kit/tovtk.git .
```
Use [`pip`](https://pip.pypa.io/en/stable/) to install:
```bash
# with --user option does not require admin rights, 
# but PATH variable may need adjustments to point to 
# $HOME/.local/bin
>pip install --user -e .
# Or without the --user option. in this case requires admin rights
>sudo pip install -e .
```
If `pip` is not available in the system, it can be installed with the following commands:

```bash
# Download pip distribution, see https://pip.pypa.io/en/stable/installing/
>wget https://bootstrap.pypa.io/get-pip.py
# To install locally:
>python get-pip.py --user
# To install system-wide:
>sudo python get-pip.py
```
The local variant installs `pip` to `$HOME/.local/bin`. Ensure to add this folder to the `$PATH` variable.

## Dependensies
The tovtk package uses the numpy package and Python bindings to VTK library. In
a recent ubuntu they can be installed with 
```bash
>sudo apt-get install python-numpy
>sudo apt-get install python-vtk
```

Alternatively, the [Anaconda](https://www.continuum.io) distribution can be used. 
Anaconda is the Pyhton distribution for different OS that includes many precompiled
science packages, among them numpy and vtk. It can be installed to the local
user filespace using the following recipe:
```bash
# Download distribution
>wget https://repo.anaconda.com/archive/Anaconda2-5.2.0-Linux-x86_64.sh
# Change access rights of the downloaded file to run it:
>chmod u+x ./Anaconda2-5.2.0-Linux-x86_64.sh
# Start installation. 
./Anaconda2-5.2.0-Linux-x86_64.sh
```
The installer asks interactively to agree to the license and to specify the
installation directory. The default installation directory is in the user
account therefore no adiministrator rights are needed. The installer also
modifies the user's `.bashrc` configuration file, so the default Python
interpreter is that installed with Anaconda. 

## Under windows
The current version of Python 2.7 is shipped with `pip`, which can be used to install the precompiled `numpy` package.