uffutils


Nameuffutils JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryA set of commandline tools for manipulating UFF files.
upload_time2025-01-22 11:35:27
maintainerNone
docs_urlNone
authorJan Hein de Jong
requires_python>=3.13
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # UFF Utils 

This library contains a set of pipeline tools for manipulating UFF files. It works a bit like this: 

```sh
uffutils modify my_original_file.uff my_subset_file.uff --node-step 100 --node-count 1000
$nodes = $(uffutils describe my_subset_file.uff --nodes-only)
uffutils modify my_file.uff my_output.uff `
    --node-selection $nodes `
    --scale-length 1000 `
    --to-global-frame `
    --rotate 90,90,90 `
    --translate 100,100,100
```

# The `inspect` command 

```sh 
uffutils inspect my_file.uff  # Nice overview 
uffutils inspect my_file.uff --property nodes --full # Full list of nodes
uffutils inspect my_file.uff --sets 0 # Description of dataset 0, including available properties
uffutils inspect my_file.uff --sets 1 --property r1,r2,r3 --mean
```

Basically, we have several options: 

```sh 
--full/--mean/--max/--summary  # Tells what to do with a range of numbers (default is summary)
--properties [string]  # What properties to focus on; if just one property is selected, no labelling is applied (default is all)
--sets [int] # What sets to focus on (default is None)
```

# Alternative implementation

I considered doing something with piping, but got stuck in the fact the the PyUFF library I'm using can't handle streams. It would've looking something like this: 

```sh
uffutils subset my_original_file.uff my_subset_file.uff --step 100 
uffutils subset my_file.uff - --nodes $(uffutils describe my_subset_file.uff --nodes) | 
uffutils scale - my_output.uff --length 1000 
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "uffutils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.13",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jan Hein de Jong",
    "author_email": "janhein.dejong@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b7/80/7d9910612ff71af2f73a3538adc69b7ca677773df21ed2a12d850b9717a7/uffutils-0.1.0.tar.gz",
    "platform": null,
    "description": "# UFF Utils \n\nThis library contains a set of pipeline tools for manipulating UFF files. It works a bit like this: \n\n```sh\nuffutils modify my_original_file.uff my_subset_file.uff --node-step 100 --node-count 1000\n$nodes = $(uffutils describe my_subset_file.uff --nodes-only)\nuffutils modify my_file.uff my_output.uff `\n    --node-selection $nodes `\n    --scale-length 1000 `\n    --to-global-frame `\n    --rotate 90,90,90 `\n    --translate 100,100,100\n```\n\n# The `inspect` command \n\n```sh \nuffutils inspect my_file.uff  # Nice overview \nuffutils inspect my_file.uff --property nodes --full # Full list of nodes\nuffutils inspect my_file.uff --sets 0 # Description of dataset 0, including available properties\nuffutils inspect my_file.uff --sets 1 --property r1,r2,r3 --mean\n```\n\nBasically, we have several options: \n\n```sh \n--full/--mean/--max/--summary  # Tells what to do with a range of numbers (default is summary)\n--properties [string]  # What properties to focus on; if just one property is selected, no labelling is applied (default is all)\n--sets [int] # What sets to focus on (default is None)\n```\n\n# Alternative implementation\n\nI considered doing something with piping, but got stuck in the fact the the PyUFF library I'm using can't handle streams. It would've looking something like this: \n\n```sh\nuffutils subset my_original_file.uff my_subset_file.uff --step 100 \nuffutils subset my_file.uff - --nodes $(uffutils describe my_subset_file.uff --nodes) | \nuffutils scale - my_output.uff --length 1000 \n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A set of commandline tools for manipulating UFF files.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5457cb6a83cdcdfafffcf30b7013031fe850c94007b5e273b2c91eb9df0a1dea",
                "md5": "e25f80c6fa6c2d617b8c5a6af363c8bd",
                "sha256": "6dc138b881a7f6217f6807eecd261165c69986bc55fadc3f43b098b231a3e4a5"
            },
            "downloads": -1,
            "filename": "uffutils-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e25f80c6fa6c2d617b8c5a6af363c8bd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.13",
            "size": 6647,
            "upload_time": "2025-01-22T11:35:25",
            "upload_time_iso_8601": "2025-01-22T11:35:25.973817Z",
            "url": "https://files.pythonhosted.org/packages/54/57/cb6a83cdcdfafffcf30b7013031fe850c94007b5e273b2c91eb9df0a1dea/uffutils-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b7807d9910612ff71af2f73a3538adc69b7ca677773df21ed2a12d850b9717a7",
                "md5": "acecfc5436021e40255152f39f0e179c",
                "sha256": "98cef7df9d5d15840578b4df854e6bc768274ca03fbb82498e1aff06cf41a2dc"
            },
            "downloads": -1,
            "filename": "uffutils-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "acecfc5436021e40255152f39f0e179c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.13",
            "size": 4315,
            "upload_time": "2025-01-22T11:35:27",
            "upload_time_iso_8601": "2025-01-22T11:35:27.913115Z",
            "url": "https://files.pythonhosted.org/packages/b7/80/7d9910612ff71af2f73a3538adc69b7ca677773df21ed2a12d850b9717a7/uffutils-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-22 11:35:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "uffutils"
}
        
Elapsed time: 9.74290s