{"id":28557197,"url":"https://github.com/volumegraphics/vg-nde-sdk","last_synced_at":"2026-06-10T16:31:53.674Z","repository":{"id":295814509,"uuid":"970729635","full_name":"VolumeGraphics/vg-nde-sdk","owner":"VolumeGraphics","description":"SDK that can create .xvgi files, for easy import of supported data into VG software","archived":false,"fork":false,"pushed_at":"2025-05-27T13:10:24.000Z","size":21108,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-22T06:36:07.445Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VolumeGraphics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-22T12:58:45.000Z","updated_at":"2025-05-28T11:11:57.000Z","dependencies_parsed_at":"2025-05-27T14:34:30.893Z","dependency_job_id":null,"html_url":"https://github.com/VolumeGraphics/vg-nde-sdk","commit_stats":null,"previous_names":["volumegraphics/vg-nde-sdk"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/VolumeGraphics/vg-nde-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolumeGraphics%2Fvg-nde-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolumeGraphics%2Fvg-nde-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolumeGraphics%2Fvg-nde-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolumeGraphics%2Fvg-nde-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VolumeGraphics","download_url":"https://codeload.github.com/VolumeGraphics/vg-nde-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolumeGraphics%2Fvg-nde-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34161283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-10T07:09:17.213Z","updated_at":"2026-06-10T16:31:53.670Z","avatar_url":"https://github.com/VolumeGraphics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\nThe VG NDE SDK contains python interfaces to write the .xvgi file format. XVGI is a simple text format that enables the\neasy import of supported data into VG software. It is also possible to add pre-defined or custom meta information for\nthe imported objects, for use in reporting or data exports, e.g. when connecting to Q-DAS products.\n![Image](docs/images/data_types.png)\nThree kinds of data can be described by .xvgi files:\n * Volume data\n * Mesh data\n * Projection data for reconstruction.\n\nOne or more objects of each data type can be described, and different data types can also be mixed, e.g. to import\na volume object and a mesh object into the same project.\n\n\u003e Oftentimes .vgl projects can already be created by the software of the acquisition system. In these cases there\n\u003e is no benefit to using the VG NDE SDK. \n\n# Describing data for import\n\nThe data that is supposed to be imported must be described using the structures provided by the SDK. The three \nclasses for holding all import parameters are the `VolumeSection`, the `MeshSection` and the `ReconstructionSection`.\nThe parameters necessary to set up the import of the data mirror the parameters available in the various importers\nin VG software. A good way to set up .xvgi files for certain data is to first manually configure the import in VG\nsoftware, making sure it works, and then setting up a corresponding section object.\nThe parameter objects must then be written to an .xvgi file using the `XVGIWriter`. VG software always assumes .xvgi\nfiles to be UTF-8 encoded, so be sure to set the correct encoding when writing the file.\n\nThe section classes also contain documentation for all parameters. HTML documentation for them can be generated in\nthe docs folder like so:\n ```shell\n  make html\n ```\n\n\u003e The `examples` folder contains examples of how to create files referencing volume or mesh data, or projections for \n\u003e reconstruction.\n \n# Referenced data\n\n.xvgi files reference the data that is to be imported via absolute file paths. These file paths must be accessible to\nthe application loading the .xvgi file, making it dependent on the original location of the data. If the\nreferenced data is intended to be moved or copied together with the .xvgi file (and the .vgl file eventually created \nfrom it), a **[vg-data] folder** must be used.\n\n# [vg-data] folder\n\nData that is referenced by the file **test.xvgi** can be stored in the matching **[vg-data] test** folder. Any file\npaths that point into a [vg-data] folder using the same name as an .xvgi file will be automatically adjusted to point\ninto the [vg-data] folder next to the .xvgi file when it is loaded. Organizing and referencing data this way ensures\nthat .xvgi files and their associated [vg-data] folder can be moved and copied around easily.\n\n![Image](docs/images/folder_and_file.png)\n\n# Using .xvgi files\nVG software products starting from 2025.1 version are able to load these files, and support their use in\n * Open\n * Merge object(s)\n * Batch processing\n\n.xvgi files are compatible with VG software version as new as or newer than the VG NDE SDK version that was used\nto write the file. VG software older than the SDK version used to create an .xvgi file might not be able to load these\nfiles. Currently all files created with this SDK are compatible with VG software version 2025.1 and above. \n\nOnce loaded, the resulting project can be saved as a normal .vgl file, and the .xvgi file is no longer necessary.\nIt is only used for the initial import of the data, and can be discarded. It is strongly recommended to use the name\nof the .xvgi file when saving, as is proposed by the software. This helps maintaining the association with referenced\ndata.\n\n\u003e myVGL can not open .xvgi files. A licensed application needs to be used to turn the .xvgi file into a .vgl file, which\n\u003e can then be viewed in myVGL in the usual way.\n\n# Requirements\n\nRequires Python 3.9 or newer.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolumegraphics%2Fvg-nde-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolumegraphics%2Fvg-nde-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolumegraphics%2Fvg-nde-sdk/lists"}