https://github.com/koushikphy/kfutils

A common file operation utility
https://github.com/koushikphy/kfutils

data-analysis data-files data-operations file-operations interpolation numerical-analysis python python-library python-package

Last synced: 16 days ago
JSON representation

A common file operation utility

• Host: GitHub
• URL: https://github.com/koushikphy/kfutils
• Owner: Koushikphy
• License: mit
• Created: 2022-02-20T14:09:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-13T15:53:43.000Z (over 1 year ago)
• Last Synced: 2024-12-20T19:22:34.331Z (about 1 month ago)
• Topics: data-analysis, data-files, data-operations, file-operations, interpolation, numerical-analysis, python, python-library, python-package
• Language: Python
• Homepage:
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## `kfutils`: A tool for common data file operations.

[![Alt text](https://img.shields.io/pypi/v/kfutils.svg?logo=pypi)](https://pypi.org/project/kfutils/)

[![Alt text](https://img.shields.io/pypi/pyversions/kfutils.svg?logo=python)](https://pypi.org/project/kfutils/)

[![Alt text](https://img.shields.io/pypi/dm/kfutils.svg)](https://pypi.org/project/kfutils/)

[![Alt text](https://img.shields.io/pypi/l/kfutils.svg)](https://pypi.org/project/kfutils/)

[![Alt text](https://img.shields.io/pypi/status/kfutils.svg)](https://pypi.org/project/kfutils/)

[![Alt text](https://github.com/koushikphy/kfutils/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Koushikphy/kfutils/releases/latest)

### ⚒ Instalation

Download and install the latest package from the [release section](https://github.com/Koushikphy/kfutils/releases/latest) or directly by pip

```bash

pip install kfutils

```

This installs the python module and a command line tool named `kfutils`.  

### ⚡ Usage 

 __✈ Using as a command line tool.__

```bash

kutils [-h] -i FILE [-o FILE] [-c COLS [COLS ...]] [-rd COLS [COLS ...]] [-dr COLS [COLS ...]] [-dc COLS [COLS ...]] [-int N [N ...]] [-mir N] [-rep N]

```

| Argument    |  Description|

| ----------- | ----------- 

|    `-i`     | Input file name 
If no operations are given it will show the stats about the file |

|    `-o`     | Output file name. (default: '_out' prefix to input file name) | 

|    `-c`     | Index(s) of grid columns. 2 columns for 2D file | 

|    `-rd`    | Index(s) of columns to convert to degree from radian |

|    `-dr`    | Index(s) of columns to convert to radian from degree |

|    `-dc`    | Index(s) of columns to delete |

|    `-int`   | Number of grid to interpolate to. Can be 1D or 2D |  

|    `-mir`   | Number of times to mirror |  

|    `-rep`   | Number of times to repeat |  

 __🚀 Using as a python module__  

The toplevel python module `kfutils` exposes several functions/class.