xdmfviewer 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- xdmfviewer-0.1.0/.github/workflows/publish-pypi.yml +31 -0
- xdmfviewer-0.1.0/.github/workflows/tests.yml +28 -0
- xdmfviewer-0.1.0/.github/workflows/windows-installer-release.yml +208 -0
- xdmfviewer-0.1.0/.gitignore +8 -0
- xdmfviewer-0.1.0/LICENSE +73 -0
- xdmfviewer-0.1.0/PKG-INFO +107 -0
- xdmfviewer-0.1.0/README.md +79 -0
- xdmfviewer-0.1.0/pyproject.toml +50 -0
- xdmfviewer-0.1.0/src/xdmfviewer/__init__.py +6 -0
- xdmfviewer-0.1.0/src/xdmfviewer/__main__.py +7 -0
- xdmfviewer-0.1.0/src/xdmfviewer/app.py +1725 -0
- xdmfviewer-0.1.0/src/xdmfviewer/cli.py +85 -0
- xdmfviewer-0.1.0/src/xdmfviewer/version.py +5 -0
- xdmfviewer-0.1.0/tests/conftest.py +91 -0
- xdmfviewer-0.1.0/tests/test_helpers.py +38 -0
- xdmfviewer-0.1.0/tests/test_version.py +7 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build-and-publish:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
id-token: write
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
- name: Check out repository
|
|
17
|
+
uses: actions/checkout@v4
|
|
18
|
+
|
|
19
|
+
- name: Set up Python
|
|
20
|
+
uses: actions/setup-python@v5
|
|
21
|
+
with:
|
|
22
|
+
python-version: "3.11"
|
|
23
|
+
|
|
24
|
+
- name: Install build tools
|
|
25
|
+
run: python -m pip install --upgrade pip build
|
|
26
|
+
|
|
27
|
+
- name: Build package
|
|
28
|
+
run: python -m build
|
|
29
|
+
|
|
30
|
+
- name: Publish package to PyPI
|
|
31
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
name: Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- "**"
|
|
7
|
+
pull_request:
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
test:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- name: Check out repository
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Set up Python
|
|
18
|
+
uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: "3.11"
|
|
21
|
+
|
|
22
|
+
- name: Install package and test dependencies
|
|
23
|
+
run: |
|
|
24
|
+
python -m pip install --upgrade pip
|
|
25
|
+
python -m pip install -e ".[dev]"
|
|
26
|
+
|
|
27
|
+
- name: Run tests
|
|
28
|
+
run: pytest
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
name: Build Windows MSI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build-windows-msi:
|
|
10
|
+
runs-on: windows-latest
|
|
11
|
+
permissions:
|
|
12
|
+
contents: write
|
|
13
|
+
|
|
14
|
+
steps:
|
|
15
|
+
- name: Check out repository
|
|
16
|
+
uses: actions/checkout@v4
|
|
17
|
+
|
|
18
|
+
- name: Set up Python
|
|
19
|
+
uses: actions/setup-python@v5
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.11"
|
|
22
|
+
|
|
23
|
+
- name: Install build dependencies
|
|
24
|
+
shell: pwsh
|
|
25
|
+
run: |
|
|
26
|
+
python -m pip install --upgrade pip
|
|
27
|
+
python -m pip install -e ".[qt]" pyinstaller
|
|
28
|
+
|
|
29
|
+
- name: Build Windows executable
|
|
30
|
+
shell: pwsh
|
|
31
|
+
run: |
|
|
32
|
+
pyinstaller `
|
|
33
|
+
--noconfirm `
|
|
34
|
+
--clean `
|
|
35
|
+
--onedir `
|
|
36
|
+
--windowed `
|
|
37
|
+
--name xdmfviewer `
|
|
38
|
+
--distpath build\app `
|
|
39
|
+
--workpath build\pyinstaller `
|
|
40
|
+
--specpath build\spec `
|
|
41
|
+
--paths src `
|
|
42
|
+
--collect-all pyvista `
|
|
43
|
+
--collect-all pyvistaqt `
|
|
44
|
+
--collect-all qtpy `
|
|
45
|
+
--collect-submodules vtkmodules `
|
|
46
|
+
src/xdmfviewer/__main__.py
|
|
47
|
+
|
|
48
|
+
- name: Install WiX toolset
|
|
49
|
+
shell: pwsh
|
|
50
|
+
run: |
|
|
51
|
+
dotnet tool install --tool-path .tools wix
|
|
52
|
+
|
|
53
|
+
- name: Build MSI package
|
|
54
|
+
shell: pwsh
|
|
55
|
+
env:
|
|
56
|
+
PRODUCT_VERSION: ${{ github.ref_name }}
|
|
57
|
+
run: |
|
|
58
|
+
$version = $env:PRODUCT_VERSION.TrimStart('v')
|
|
59
|
+
$appRoot = Join-Path $PWD.Path 'build\app\xdmfviewer'
|
|
60
|
+
$wxsPath = Join-Path $PWD.Path 'build\installer-generated.wxs'
|
|
61
|
+
New-Item -ItemType Directory -Force -Path dist | Out-Null
|
|
62
|
+
|
|
63
|
+
function Get-ShortHash {
|
|
64
|
+
param([string]$Text)
|
|
65
|
+
|
|
66
|
+
$sha1 = [System.Security.Cryptography.SHA1]::Create()
|
|
67
|
+
try {
|
|
68
|
+
$bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
|
|
69
|
+
$hash = $sha1.ComputeHash($bytes)
|
|
70
|
+
return (([System.BitConverter]::ToString($hash)).Replace('-', '').Substring(0, 12))
|
|
71
|
+
}
|
|
72
|
+
finally {
|
|
73
|
+
$sha1.Dispose()
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function New-Id {
|
|
78
|
+
param(
|
|
79
|
+
[string]$Prefix,
|
|
80
|
+
[string]$Text
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
return "$Prefix$(Get-ShortHash -Text $Text)"
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
function Get-RelativePath {
|
|
87
|
+
param([string]$FullPath)
|
|
88
|
+
|
|
89
|
+
return $FullPath.Substring($appRoot.Length + 1)
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
$allDirectories = Get-ChildItem -Path $appRoot -Directory -Recurse | Sort-Object FullName
|
|
93
|
+
$allFiles = Get-ChildItem -Path $appRoot -File -Recurse | Sort-Object FullName
|
|
94
|
+
|
|
95
|
+
$directoryChildren = @{}
|
|
96
|
+
$directoryChildren[''] = @()
|
|
97
|
+
$directoryIds = @{
|
|
98
|
+
'' = 'INSTALLFOLDER'
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
foreach ($directory in $allDirectories) {
|
|
102
|
+
$relativeDirectory = Get-RelativePath -FullPath $directory.FullName
|
|
103
|
+
$parentDirectory = Split-Path $relativeDirectory -Parent
|
|
104
|
+
if ($parentDirectory -eq '.') {
|
|
105
|
+
$parentDirectory = ''
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
$directoryIds[$relativeDirectory] = New-Id -Prefix 'Dir_' -Text $relativeDirectory
|
|
109
|
+
if (-not $directoryChildren.ContainsKey($parentDirectory)) {
|
|
110
|
+
$directoryChildren[$parentDirectory] = @()
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
$directoryChildren[$parentDirectory] += $relativeDirectory
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
function Write-DirectoryTree {
|
|
117
|
+
param(
|
|
118
|
+
[string]$RelativePath,
|
|
119
|
+
[int]$Indent
|
|
120
|
+
)
|
|
121
|
+
|
|
122
|
+
$padding = ' ' * $Indent
|
|
123
|
+
foreach ($child in $directoryChildren[$RelativePath]) {
|
|
124
|
+
$childName = Split-Path $child -Leaf
|
|
125
|
+
$childId = $directoryIds[$child]
|
|
126
|
+
Add-Content -Path $wxsPath -Value "$padding<Directory Id=`"$childId`" Name=`"$childName`">"
|
|
127
|
+
Write-DirectoryTree -RelativePath $child -Indent ($Indent + 2)
|
|
128
|
+
Add-Content -Path $wxsPath -Value "$padding</Directory>"
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
@'
|
|
133
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
134
|
+
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
|
|
135
|
+
<Package
|
|
136
|
+
Name="xdmfviewer"
|
|
137
|
+
Manufacturer="xdmfviewer contributors"
|
|
138
|
+
Version="$(var.ProductVersion)"
|
|
139
|
+
UpgradeCode="8c4bc4cb-7d6a-4d7b-a565-29f6f8f3a8a5"
|
|
140
|
+
Scope="perUser"
|
|
141
|
+
Compressed="yes">
|
|
142
|
+
<MajorUpgrade DowngradeErrorMessage="Eine neuere Version von xdmfviewer ist bereits installiert." />
|
|
143
|
+
<MediaTemplate />
|
|
144
|
+
|
|
145
|
+
<Feature Id="MainFeature" Title="xdmfviewer" Level="1">
|
|
146
|
+
<ComponentGroupRef Id="ApplicationComponents" />
|
|
147
|
+
</Feature>
|
|
148
|
+
</Package>
|
|
149
|
+
|
|
150
|
+
<Fragment>
|
|
151
|
+
<StandardDirectory Id="LocalAppDataFolder">
|
|
152
|
+
<Directory Id="INSTALLFOLDER" Name="xdmfviewer">
|
|
153
|
+
'@ | Set-Content -Path $wxsPath -Encoding utf8
|
|
154
|
+
|
|
155
|
+
Write-DirectoryTree -RelativePath '' -Indent 8
|
|
156
|
+
|
|
157
|
+
@'
|
|
158
|
+
</Directory>
|
|
159
|
+
</StandardDirectory>
|
|
160
|
+
|
|
161
|
+
<StandardDirectory Id="ProgramMenuFolder">
|
|
162
|
+
<Directory Id="ApplicationProgramsFolder" Name="xdmfviewer" />
|
|
163
|
+
</StandardDirectory>
|
|
164
|
+
</Fragment>
|
|
165
|
+
|
|
166
|
+
<Fragment>
|
|
167
|
+
<ComponentGroup Id="ApplicationComponents" Directory="INSTALLFOLDER">
|
|
168
|
+
'@ | Add-Content -Path $wxsPath -Encoding utf8
|
|
169
|
+
|
|
170
|
+
foreach ($file in $allFiles) {
|
|
171
|
+
$relativeFile = Get-RelativePath -FullPath $file.FullName
|
|
172
|
+
$parentDirectory = Split-Path $relativeFile -Parent
|
|
173
|
+
if ($parentDirectory -eq '.') {
|
|
174
|
+
$parentDirectory = ''
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
$componentId = New-Id -Prefix 'Cmp_' -Text $relativeFile
|
|
178
|
+
$fileId = New-Id -Prefix 'File_' -Text $relativeFile
|
|
179
|
+
$directoryId = $directoryIds[$parentDirectory]
|
|
180
|
+
$sourcePath = "`$(var.BuildOutput)\$relativeFile"
|
|
181
|
+
|
|
182
|
+
Add-Content -Path $wxsPath -Value " <Component Id=`"$componentId`" Directory=`"$directoryId`" Guid=`"*`">" -Encoding utf8
|
|
183
|
+
Add-Content -Path $wxsPath -Value " <File Id=`"$fileId`" Source=`"$sourcePath`" KeyPath=`"yes`" />" -Encoding utf8
|
|
184
|
+
|
|
185
|
+
if ($relativeFile -ieq 'xdmfviewer.exe') {
|
|
186
|
+
Add-Content -Path $wxsPath -Value ' <Shortcut Id="StartMenuShortcut" Directory="ApplicationProgramsFolder" Name="xdmfviewer" WorkingDirectory="INSTALLFOLDER" Advertise="no" />' -Encoding utf8
|
|
187
|
+
Add-Content -Path $wxsPath -Value ' <RemoveFolder Id="RemoveInstallFolder" Directory="INSTALLFOLDER" On="uninstall" />' -Encoding utf8
|
|
188
|
+
Add-Content -Path $wxsPath -Value ' <RemoveFolder Id="RemoveProgramsFolder" Directory="ApplicationProgramsFolder" On="uninstall" />' -Encoding utf8
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
Add-Content -Path $wxsPath -Value ' </Component>' -Encoding utf8
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
Add-Content -Path $wxsPath -Value ' </ComponentGroup>' -Encoding utf8
|
|
195
|
+
Add-Content -Path $wxsPath -Value ' </Fragment>' -Encoding utf8
|
|
196
|
+
Add-Content -Path $wxsPath -Value '</Wix>' -Encoding utf8
|
|
197
|
+
|
|
198
|
+
.\.tools\wix.exe build `
|
|
199
|
+
$wxsPath `
|
|
200
|
+
-arch x64 `
|
|
201
|
+
-d ProductVersion=$version `
|
|
202
|
+
-d BuildOutput=$appRoot `
|
|
203
|
+
-out $($PWD.Path)\dist\xdmfviewer-windows-$version.msi
|
|
204
|
+
|
|
205
|
+
- name: Upload release asset
|
|
206
|
+
uses: softprops/action-gh-release@v2
|
|
207
|
+
with:
|
|
208
|
+
files: dist/*.msi
|
xdmfviewer-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
GNU LESSER GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 3, 29 June 2007
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
5
|
+
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
|
6
|
+
|
|
7
|
+
This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
|
|
8
|
+
|
|
9
|
+
0. Additional Definitions.
|
|
10
|
+
|
|
11
|
+
As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License.
|
|
12
|
+
|
|
13
|
+
"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
|
|
14
|
+
|
|
15
|
+
An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
|
|
16
|
+
|
|
17
|
+
A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work is made is also called the "Linked Version".
|
|
18
|
+
|
|
19
|
+
The "Minimal corresponding source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
|
|
20
|
+
|
|
21
|
+
The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the object code and/or source code for the Linked Version.
|
|
22
|
+
|
|
23
|
+
1. Exception to Section 3 of the GNU GPL.
|
|
24
|
+
|
|
25
|
+
You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
|
|
26
|
+
|
|
27
|
+
2. Conveying Modified Versions.
|
|
28
|
+
|
|
29
|
+
If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version under this License, provided that you make a good faith effort to ensure that, in the event an Application does not already supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful.
|
|
30
|
+
|
|
31
|
+
Also, you must license the entire modified work under this License. The modified Library must carry prominent notices stating that you changed it, and give a relevant date.
|
|
32
|
+
|
|
33
|
+
3. Object Code Incorporating Material from Library Header Files.
|
|
34
|
+
|
|
35
|
+
The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, and small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
|
|
36
|
+
|
|
37
|
+
a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
|
|
38
|
+
b) Accompany the object code with a copy of the GNU GPL and this license document.
|
|
39
|
+
|
|
40
|
+
4. Combined Works.
|
|
41
|
+
|
|
42
|
+
You may convey a Combined Work under the terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
|
|
43
|
+
|
|
44
|
+
a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
|
|
45
|
+
b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
|
|
46
|
+
c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
|
|
47
|
+
d) Do one of the following:
|
|
48
|
+
0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
|
|
49
|
+
1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
|
|
50
|
+
e) Verify that user already received a copy of these materials or that you have already sent this user a copy.
|
|
51
|
+
f) If the work is a derivative of the user's own work, you may convey specific modifications to the Library, and these modifications where they are used with the Linked Version, under the terms of this License (as if they were part of the Library).
|
|
52
|
+
|
|
53
|
+
5. Additional Terms.
|
|
54
|
+
|
|
55
|
+
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
|
56
|
+
|
|
57
|
+
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it.
|
|
58
|
+
|
|
59
|
+
If a covered work normally communicates with users interactively through a computer network, the network interaction point should display an appropriate notice of the copyright for the Library being used and also a notice referring users to the copies of the GNU GPL and this license document.
|
|
60
|
+
|
|
61
|
+
When a covered work contains a notice placed by the copyright holder saying it is governed by this License through a message displayed when the program starts in an interactive mode, you may remove such notice.
|
|
62
|
+
|
|
63
|
+
6. Revised Versions of this License.
|
|
64
|
+
|
|
65
|
+
The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
|
66
|
+
|
|
67
|
+
Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
|
|
68
|
+
|
|
69
|
+
7. Additional Terms Relating to the GNU GPL Which Apply to These Exceptions.
|
|
70
|
+
|
|
71
|
+
When you convey covered code, you agree in relevant part of the exception text in the terms of that exception.
|
|
72
|
+
|
|
73
|
+
If you wish to incorporate the exception handling mechanisms and conditional compilation directives from this file into precompiled source code versions of programs, or if you wish to incorporate this file into any compilation or combination of files that implements parts of this license with different copyright holders for portions of the code, you may do so under this License as long as all conditions of this License are fulfilled for the covered work.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: xdmfviewer
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Standalone PyVista/Qt viewer for XDMF result files
|
|
5
|
+
Author: xdmfviewer contributors
|
|
6
|
+
License: LGPL-3.0-or-later
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Keywords: fem,pyvista,qt,viewer,xdmf
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Intended Audience :: Science/Research
|
|
11
|
+
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Visualization
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: numpy>=1.22
|
|
20
|
+
Requires-Dist: pyvista>=0.43
|
|
21
|
+
Requires-Dist: pyvistaqt>=0.11
|
|
22
|
+
Requires-Dist: qtpy>=2.4
|
|
23
|
+
Provides-Extra: dev
|
|
24
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
25
|
+
Provides-Extra: qt
|
|
26
|
+
Requires-Dist: pyside6>=6.5; extra == 'qt'
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# xdmfviewer
|
|
30
|
+
|
|
31
|
+
A standalone desktop viewer for XDMF time-series results based on PyVista and Qt.
|
|
32
|
+
|
|
33
|
+
## Features
|
|
34
|
+
|
|
35
|
+
- Interactive visualization of XDMF time steps
|
|
36
|
+
- Point and cell field selection
|
|
37
|
+
- Scalar component selection (scalar, vector, tensor)
|
|
38
|
+
- Warp-by-vector rendering (manual opt-in)
|
|
39
|
+
- Animation playback and export (GIF/MP4)
|
|
40
|
+
- Screenshot export
|
|
41
|
+
- Hover tooltip inspection
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
Install from PyPI:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install xdmfviewer[qt]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
For development, clone the repository and install in editable mode:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
git clone <repository-url>
|
|
55
|
+
cd xdmfviewer
|
|
56
|
+
pip install -e ".[qt,dev]"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Windows release
|
|
60
|
+
|
|
61
|
+
Tagged releases publish a per-user MSI installer as a GitHub release asset.
|
|
62
|
+
Download the `.msi` file from the release page and run it normally; it installs
|
|
63
|
+
into your user profile.
|
|
64
|
+
|
|
65
|
+
The release workflow is triggered by version tags such as `v0.1.0`.
|
|
66
|
+
|
|
67
|
+
## Usage
|
|
68
|
+
|
|
69
|
+
After installation:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
xdmfviewer
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Or via module:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
python -m xdmfviewer
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Then open an `.xdmf` file from the GUI.
|
|
82
|
+
|
|
83
|
+
## Dependencies
|
|
84
|
+
|
|
85
|
+
Core runtime dependencies are declared in `pyproject.toml`:
|
|
86
|
+
|
|
87
|
+
- `numpy`
|
|
88
|
+
- `pyvista`
|
|
89
|
+
- `pyvistaqt`
|
|
90
|
+
- `qtpy`
|
|
91
|
+
|
|
92
|
+
You also need a Qt binding, for example one of:
|
|
93
|
+
|
|
94
|
+
- `PySide6`
|
|
95
|
+
- `PyQt6`
|
|
96
|
+
- `PyQt5`
|
|
97
|
+
|
|
98
|
+
The recommended install extra for this project is `qt`, which currently
|
|
99
|
+
pulls in `PySide6`.
|
|
100
|
+
|
|
101
|
+
## Acknowledgments
|
|
102
|
+
|
|
103
|
+
This project was developed with assistance from Claude (Anthropic) and GitHub Copilot.
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
This project is licensed under the GNU Lesser General Public License v3 or later (LGPL-3.0-or-later). See [LICENSE](LICENSE).
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# xdmfviewer
|
|
2
|
+
|
|
3
|
+
A standalone desktop viewer for XDMF time-series results based on PyVista and Qt.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Interactive visualization of XDMF time steps
|
|
8
|
+
- Point and cell field selection
|
|
9
|
+
- Scalar component selection (scalar, vector, tensor)
|
|
10
|
+
- Warp-by-vector rendering (manual opt-in)
|
|
11
|
+
- Animation playback and export (GIF/MP4)
|
|
12
|
+
- Screenshot export
|
|
13
|
+
- Hover tooltip inspection
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
Install from PyPI:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pip install xdmfviewer[qt]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
For development, clone the repository and install in editable mode:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
git clone <repository-url>
|
|
27
|
+
cd xdmfviewer
|
|
28
|
+
pip install -e ".[qt,dev]"
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Windows release
|
|
32
|
+
|
|
33
|
+
Tagged releases publish a per-user MSI installer as a GitHub release asset.
|
|
34
|
+
Download the `.msi` file from the release page and run it normally; it installs
|
|
35
|
+
into your user profile.
|
|
36
|
+
|
|
37
|
+
The release workflow is triggered by version tags such as `v0.1.0`.
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
After installation:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
xdmfviewer
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or via module:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
python -m xdmfviewer
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Then open an `.xdmf` file from the GUI.
|
|
54
|
+
|
|
55
|
+
## Dependencies
|
|
56
|
+
|
|
57
|
+
Core runtime dependencies are declared in `pyproject.toml`:
|
|
58
|
+
|
|
59
|
+
- `numpy`
|
|
60
|
+
- `pyvista`
|
|
61
|
+
- `pyvistaqt`
|
|
62
|
+
- `qtpy`
|
|
63
|
+
|
|
64
|
+
You also need a Qt binding, for example one of:
|
|
65
|
+
|
|
66
|
+
- `PySide6`
|
|
67
|
+
- `PyQt6`
|
|
68
|
+
- `PyQt5`
|
|
69
|
+
|
|
70
|
+
The recommended install extra for this project is `qt`, which currently
|
|
71
|
+
pulls in `PySide6`.
|
|
72
|
+
|
|
73
|
+
## Acknowledgments
|
|
74
|
+
|
|
75
|
+
This project was developed with assistance from Claude (Anthropic) and GitHub Copilot.
|
|
76
|
+
|
|
77
|
+
## License
|
|
78
|
+
|
|
79
|
+
This project is licensed under the GNU Lesser General Public License v3 or later (LGPL-3.0-or-later). See [LICENSE](LICENSE).
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.25"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "xdmfviewer"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Standalone PyVista/Qt viewer for XDMF result files"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = { text = "LGPL-3.0-or-later" }
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "xdmfviewer contributors" }
|
|
14
|
+
]
|
|
15
|
+
keywords = ["xdmf", "pyvista", "viewer", "qt", "fem"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Intended Audience :: Science/Research",
|
|
19
|
+
"License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.10",
|
|
22
|
+
"Programming Language :: Python :: 3.11",
|
|
23
|
+
"Programming Language :: Python :: 3.12",
|
|
24
|
+
"Programming Language :: Python :: 3.13",
|
|
25
|
+
"Topic :: Scientific/Engineering :: Visualization"
|
|
26
|
+
]
|
|
27
|
+
dependencies = [
|
|
28
|
+
"numpy>=1.22",
|
|
29
|
+
"pyvista>=0.43",
|
|
30
|
+
"pyvistaqt>=0.11",
|
|
31
|
+
"qtpy>=2.4"
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[project.optional-dependencies]
|
|
35
|
+
qt = [
|
|
36
|
+
"PySide6>=6.5"
|
|
37
|
+
]
|
|
38
|
+
dev = [
|
|
39
|
+
"pytest>=8.0"
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
[project.scripts]
|
|
43
|
+
xdmfviewer = "xdmfviewer.cli:main"
|
|
44
|
+
|
|
45
|
+
[tool.hatch.build.targets.wheel]
|
|
46
|
+
packages = ["src/xdmfviewer"]
|
|
47
|
+
|
|
48
|
+
[tool.pytest.ini_options]
|
|
49
|
+
testpaths = ["tests"]
|
|
50
|
+
pythonpath = ["src"]
|