hedron_scripts 0.4.1__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.
@@ -0,0 +1,68 @@
1
+ Metadata-Version: 2.3
2
+ Name: hedron_scripts
3
+ Version: 0.4.1
4
+ Summary: Add your description here
5
+ Author: Jim McNeill, Marcel Tünnissen
6
+ Author-email: Marcel Tünnissen <marcelteun@gmail.com>
7
+ Requires-Dist: moderngl>=5.12.0
8
+ Requires-Dist: numba>=0.67.0
9
+ Requires-Dist: numpy>=2.5.2
10
+ Requires-Dist: pillow>=12.3.0
11
+ Requires-Dist: pygame>=2.6.1
12
+ Requires-Dist: scipy>=1.18.0
13
+ Requires-Dist: tkinterdnd2>=0.6.2
14
+ Requires-Dist: windnd>=1.0.7
15
+ Requires-Python: >=3.12
16
+ Description-Content-Type: text/markdown
17
+
18
+ # About
19
+ These scripts were written by Jim McNeill using AI tools. I decided it would be
20
+ a good idea to add them to a git repo. These files come as is and without any
21
+ guaratees and I cannot promise that any problems will be solved any time soon.
22
+
23
+ # Using Repository from Github
24
+
25
+ After cloning the the repository the offviewer can be run from the directory through
26
+
27
+ `uv run offviewer [dir]`
28
+
29
+ This requires that you have uv installed, see [uv](https://docs.astral.sh/uv/getting-started/installation/)
30
+
31
+
32
+ # Using a Released Version
33
+
34
+ A released version can be installed by
35
+ `pip install offviewer`
36
+
37
+ It is wise to use a virtual Python environment, e.g. on Linux:
38
+ ```
39
+ python -m venv path_to_venv
40
+ . path_to_venv/bin/activate
41
+ ```
42
+
43
+ Then the script can be run by:
44
+ `offviewer [path-to-folder]`
45
+
46
+ There is also the scripts
47
+ - `offchecker`
48
+ - `facetings`
49
+
50
+ # The Off File Viewer
51
+ When you open a grid window the sort mode will be greyed out while it
52
+ calculates the metrics for the off files. Once it has done this and you select
53
+ a sort order, duplicate values of the sort parameter are highlighted in pink.
54
+ The delete duplicates button will keep the oldest file with any one value.
55
+ Float parameters have a small tolerance built in.
56
+
57
+ - Auto rotate is fun but wait until the sort button blacks up or you'll slow it down.
58
+ - + (or =) and - will zoom the cells on the grid screen-
59
+ - Any polyhedron can be rotated by left dragging with the mouse ot=r by using the arrow keys
60
+ - Double click on an image to get to the enlarged screen.
61
+ - The left and right arrows are previous/next file.
62
+ - 'f' on the enlarged screen will cycle through the face types one by one.
63
+ - 'v' cycles through the vertices
64
+ - 'e' does some edge options (also on the grid view)
65
+ - 'x' to return to the original view
66
+ - The grid view also has some functions if you right click: delete, rename, view source, open in Stella.
67
+ - The offcheck.py file is also a standalone checker. If you change the metrics that this is calculating they should flow through into offviewer automatically.
68
+ - The path and 'search' at the top of the grid screen don't work (yet) and will probably be removed
@@ -0,0 +1,51 @@
1
+ # About
2
+ These scripts were written by Jim McNeill using AI tools. I decided it would be
3
+ a good idea to add them to a git repo. These files come as is and without any
4
+ guaratees and I cannot promise that any problems will be solved any time soon.
5
+
6
+ # Using Repository from Github
7
+
8
+ After cloning the the repository the offviewer can be run from the directory through
9
+
10
+ `uv run offviewer [dir]`
11
+
12
+ This requires that you have uv installed, see [uv](https://docs.astral.sh/uv/getting-started/installation/)
13
+
14
+
15
+ # Using a Released Version
16
+
17
+ A released version can be installed by
18
+ `pip install offviewer`
19
+
20
+ It is wise to use a virtual Python environment, e.g. on Linux:
21
+ ```
22
+ python -m venv path_to_venv
23
+ . path_to_venv/bin/activate
24
+ ```
25
+
26
+ Then the script can be run by:
27
+ `offviewer [path-to-folder]`
28
+
29
+ There is also the scripts
30
+ - `offchecker`
31
+ - `facetings`
32
+
33
+ # The Off File Viewer
34
+ When you open a grid window the sort mode will be greyed out while it
35
+ calculates the metrics for the off files. Once it has done this and you select
36
+ a sort order, duplicate values of the sort parameter are highlighted in pink.
37
+ The delete duplicates button will keep the oldest file with any one value.
38
+ Float parameters have a small tolerance built in.
39
+
40
+ - Auto rotate is fun but wait until the sort button blacks up or you'll slow it down.
41
+ - + (or =) and - will zoom the cells on the grid screen-
42
+ - Any polyhedron can be rotated by left dragging with the mouse ot=r by using the arrow keys
43
+ - Double click on an image to get to the enlarged screen.
44
+ - The left and right arrows are previous/next file.
45
+ - 'f' on the enlarged screen will cycle through the face types one by one.
46
+ - 'v' cycles through the vertices
47
+ - 'e' does some edge options (also on the grid view)
48
+ - 'x' to return to the original view
49
+ - The grid view also has some functions if you right click: delete, rename, view source, open in Stella.
50
+ - The offcheck.py file is also a standalone checker. If you change the metrics that this is calculating they should flow through into offviewer automatically.
51
+ - The path and 'search' at the top of the grid screen don't work (yet) and will probably be removed
@@ -0,0 +1,35 @@
1
+ [project]
2
+ name = "hedron_scripts"
3
+ version = "0.4.1"
4
+ description = "Add your description here"
5
+ readme = "README.md"
6
+ requires-python = ">=3.12"
7
+ dependencies = [
8
+ "moderngl>=5.12.0",
9
+ "numba>=0.67.0",
10
+ "numpy>=2.5.2",
11
+ "pillow>=12.3.0",
12
+ "pygame>=2.6.1",
13
+ "scipy>=1.18.0",
14
+ "tkinterdnd2>=0.6.2",
15
+ "windnd>=1.0.7",
16
+ ]
17
+
18
+ [[project.authors]]
19
+ name = "Jim McNeill"
20
+
21
+ [[project.authors]]
22
+ name = "Marcel Tünnissen"
23
+ email = "marcelteun@gmail.com"
24
+
25
+ [project.scripts]
26
+ facetings = "offviewer.facetings:main"
27
+ offchecker = "offviewer.offchecker:main"
28
+ offviewer = "offviewer.offviewer:main"
29
+
30
+ [build-system]
31
+ requires = ["uv_build>=0.12.3,<0.13.0"]
32
+ build-backend = "uv_build"
33
+
34
+ [dependency-groups]
35
+ dev = ["ruff>=0.16.3"]
@@ -0,0 +1,34 @@
1
+ [project]
2
+ name = "hedron_scripts"
3
+ version = "0.4.1"
4
+ description = "Add your description here"
5
+ readme = "README.md"
6
+ authors = [
7
+ { name = "Jim McNeill" },
8
+ { name = "Marcel Tünnissen", email = "marcelteun@gmail.com" },
9
+ ]
10
+ requires-python = ">=3.12"
11
+ dependencies = [
12
+ "moderngl>=5.12.0",
13
+ "numba>=0.67.0",
14
+ "numpy>=2.5.2",
15
+ "pillow>=12.3.0",
16
+ "pygame>=2.6.1",
17
+ "scipy>=1.18.0",
18
+ "tkinterdnd2>=0.6.2",
19
+ "windnd>=1.0.7",
20
+ ]
21
+
22
+ [project.scripts]
23
+ facetings = "offviewer.facetings:main"
24
+ offchecker = "offviewer.offchecker:main"
25
+ offviewer = "offviewer.offviewer:main"
26
+
27
+ [build-system]
28
+ requires = ["uv_build>=0.12.3,<0.13.0"]
29
+ build-backend = "uv_build"
30
+
31
+ [dependency-groups]
32
+ dev = [
33
+ "ruff>=0.16.3",
34
+ ]
@@ -0,0 +1 @@
1
+ from offviewer.offviewer import *
@@ -0,0 +1,5 @@
1
+ from offviewer.lib.facetings import main
2
+
3
+
4
+ if __name__ == "__main__":
5
+ main()