uffutils


Nameuffutils JSON
Version 0.6.0 PyPI version JSON
download
home_pageNone
SummaryA set of commandline tools for manipulating UFF files.
upload_time2025-07-22 09:16:25
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # UFFUtils

A Python-based command-line tool for manipulating UFF datasets.

[![PyPI version](https://badge.fury.io/py/uffutils.svg)](https://pypi.org/project/uffutils/)
[![PyPi status](https://img.shields.io/pypi/status/uffutils)](https://pypi.org/project/uffutils/)
![Release date](https://img.shields.io/github/release-date-pre/janheindejong/uffutils)
![Python Package CI](https://github.com/janheindejong/uffutils/actions/workflows/python-package.yml/badge.svg?branch=main)
![Monthly downloads](https://img.shields.io/pypi/dm/uffutils)
![License](https://img.shields.io/pypi/l/uffutils)
![Python versions](https://img.shields.io/pypi/pyversions/uffutils)

## Introduction

UFFUtils lets you inspect and manipulate UFF files. Let's look at an example.

Say you have some dataset - `my_data.uff` - that you want to reduce in size (e.g., by only taking every 1000th node), scale from mm to m, rotate around the y-axis by 90 degrees. With UFFUtils, you would do this in the following way:

```powershell
uffutils subset my_data.uff --step 1000 `
uffutils scale --length 0.001 `
uffutils rotate - rotated.uff --angles 0 90 0
```

Congratulations! You now have a reduced, scaled and rotated version of your dataset!

For more functionality, see the description of each command below.

## Installing

A good way to run UFF utils is through [`uv`](https://docs.astral.sh/uv/getting-started/installation/). Once you have installed `uv`, you can run `uffutils` like so:

```powershell
uvx uffutils
```

No need for any additional software (e.g., Python); `uv` handles it for you.

## Usage

### The `inspect` command

The `inspect` command allows you to view the contents of a UFF file. Example usage:

```powershell
uffutils inspect my_file.uff  # Print nice overview 
uffutils inspect my_file.uff --nodes # Print full list of nodes
```

### The `subset` command

Allows you to create file with a subset of nodes, which is particularly useful if you want to downsize a UFF file. Usage:

```powershell
uffutils subset input.uff output.uff --ids "1,2,3"  # Only takes nodes 1, 2 and 3
uffutils subset input.uff output.uff --step 1000  # Takes every 1000th node, starting at 1 
uffutils subset input.uff output.uff --max 100 # Takes the first 100 nodes 
```

Operations can be combined. The following operation yields a file with nodes 10 and 30.

```powershell
uffutils subset input.uff output.uff --selection "10,20,30,40,50" --step 2 --max 2
```

### The `scale` command  

You can scale length:

```powershell
uffutils scale input.uff output.uff --length 1000 
```

### The `translate` command

You can translate the data:

```powershell
uffutils translate input.uff output.uff --xyz 10.0 20.0 30.0 
```

### The `rotate` command

You can rotate the data:

```powershell
uffutils rotate input.uff output.uff --angles 90 90 90
```

### Combining commands

You can combine commands through piping, like so:

```powershell
uffutils subset input.uff --step 100 | `
    uffutils scale --length 1000 | `
    uffutils move --xyz 10 20 30 | `
    uffutils rotate - output.uff --xyz 90 0 0 
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "uffutils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Jan Hein de Jong <janhein.dejong@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/34/9a/966cd62269964de5afa40aca179b4a6e8f442642334f83f72baeb81e4828/uffutils-0.6.0.tar.gz",
    "platform": null,
    "description": "# UFFUtils\n\nA Python-based command-line tool for manipulating UFF datasets.\n\n[![PyPI version](https://badge.fury.io/py/uffutils.svg)](https://pypi.org/project/uffutils/)\n[![PyPi status](https://img.shields.io/pypi/status/uffutils)](https://pypi.org/project/uffutils/)\n![Release date](https://img.shields.io/github/release-date-pre/janheindejong/uffutils)\n![Python Package CI](https://github.com/janheindejong/uffutils/actions/workflows/python-package.yml/badge.svg?branch=main)\n![Monthly downloads](https://img.shields.io/pypi/dm/uffutils)\n![License](https://img.shields.io/pypi/l/uffutils)\n![Python versions](https://img.shields.io/pypi/pyversions/uffutils)\n\n## Introduction\n\nUFFUtils lets you inspect and manipulate UFF files. Let's look at an example.\n\nSay you have some dataset - `my_data.uff` - that you want to reduce in size (e.g., by only taking every 1000th node), scale from mm to m, rotate around the y-axis by 90 degrees. With UFFUtils, you would do this in the following way:\n\n```powershell\nuffutils subset my_data.uff --step 1000 `\nuffutils scale --length 0.001 `\nuffutils rotate - rotated.uff --angles 0 90 0\n```\n\nCongratulations! You now have a reduced, scaled and rotated version of your dataset!\n\nFor more functionality, see the description of each command below.\n\n## Installing\n\nA good way to run UFF utils is through [`uv`](https://docs.astral.sh/uv/getting-started/installation/). Once you have installed `uv`, you can run `uffutils` like so:\n\n```powershell\nuvx uffutils\n```\n\nNo need for any additional software (e.g., Python); `uv` handles it for you.\n\n## Usage\n\n### The `inspect` command\n\nThe `inspect` command allows you to view the contents of a UFF file. Example usage:\n\n```powershell\nuffutils inspect my_file.uff  # Print nice overview \nuffutils inspect my_file.uff --nodes # Print full list of nodes\n```\n\n### The `subset` command\n\nAllows you to create file with a subset of nodes, which is particularly useful if you want to downsize a UFF file. Usage:\n\n```powershell\nuffutils subset input.uff output.uff --ids \"1,2,3\"  # Only takes nodes 1, 2 and 3\nuffutils subset input.uff output.uff --step 1000  # Takes every 1000th node, starting at 1 \nuffutils subset input.uff output.uff --max 100 # Takes the first 100 nodes \n```\n\nOperations can be combined. The following operation yields a file with nodes 10 and 30.\n\n```powershell\nuffutils subset input.uff output.uff --selection \"10,20,30,40,50\" --step 2 --max 2\n```\n\n### The `scale` command  \n\nYou can scale length:\n\n```powershell\nuffutils scale input.uff output.uff --length 1000 \n```\n\n### The `translate` command\n\nYou can translate the data:\n\n```powershell\nuffutils translate input.uff output.uff --xyz 10.0 20.0 30.0 \n```\n\n### The `rotate` command\n\nYou can rotate the data:\n\n```powershell\nuffutils rotate input.uff output.uff --angles 90 90 90\n```\n\n### Combining commands\n\nYou can combine commands through piping, like so:\n\n```powershell\nuffutils subset input.uff --step 100 | `\n    uffutils scale --length 1000 | `\n    uffutils move --xyz 10 20 30 | `\n    uffutils rotate - output.uff --xyz 90 0 0 \n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A set of commandline tools for manipulating UFF files.",
    "version": "0.6.0",
    "project_urls": {
        "Homepage": "https://github.com/janheindejong/uffutils",
        "Repository": "https://github.com/janheindejong/uffutils"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f543176c8cdffb7ecb2d157c608662f7519daeeab55f691b5d1bd5986595b63f",
                "md5": "e84a872e2674e1de5a51352109cfb128",
                "sha256": "3dc1507e0c8cb7891d1360def902d58f66c03c0516cd71216e77bca57f571a7a"
            },
            "downloads": -1,
            "filename": "uffutils-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e84a872e2674e1de5a51352109cfb128",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 8411,
            "upload_time": "2025-07-22T09:16:23",
            "upload_time_iso_8601": "2025-07-22T09:16:23.799376Z",
            "url": "https://files.pythonhosted.org/packages/f5/43/176c8cdffb7ecb2d157c608662f7519daeeab55f691b5d1bd5986595b63f/uffutils-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "349a966cd62269964de5afa40aca179b4a6e8f442642334f83f72baeb81e4828",
                "md5": "928ecf5f24aa38fdd408c36c6b65b774",
                "sha256": "318178439c9f556a92f882889cadc1383bd347cf07f9b5b74ce496762125d491"
            },
            "downloads": -1,
            "filename": "uffutils-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "928ecf5f24aa38fdd408c36c6b65b774",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 57654,
            "upload_time": "2025-07-22T09:16:25",
            "upload_time_iso_8601": "2025-07-22T09:16:25.338103Z",
            "url": "https://files.pythonhosted.org/packages/34/9a/966cd62269964de5afa40aca179b4a6e8f442642334f83f72baeb81e4828/uffutils-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-22 09:16:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "janheindejong",
    "github_project": "uffutils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "uffutils"
}
        
Elapsed time: 4.31540s