Refactored into Paclet

flip phillips · flip phillips · commit 7a5d7e826d05 · 2018-06-06T13:19:07.000-04:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,8 @@
-*.jpg filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
 *.nb filter=lfs diff=lfs merge=lfs -text
+*.mx filter=lfs diff=lfs merge=lfs -text
+
+*.png filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.ply filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.psd filter=lfs diff=lfs merge=lfs -text
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+*.paclet
+.DS_Store
+MonitorUtilities/Globals.wl
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "Buzing's",
+        "paclet"
+    ]
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,22 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "type": "shell",
+            "command": "/usr/bin/env wolframscript -f build.wls",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "install",
+            "type": "shell",
+            "command": "/usr/bin/env wolframscript -f install.wls",
+            "group": "build"
+        }
+    ]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@ Monitor Utilities
 ### Added
 
 - Development / test stuff
+- paclet build
 
 ## [1.0.0] - 2017-11-01
 
diff --git a/MonitorUtilities.wl b/MonitorUtilities.wl
diff --git a/MonitorUtilities/Conversions.wl b/MonitorUtilities/Conversions.wl
@@ -0,0 +1,57 @@
+(* ::Package:: *)
+
+(* display utilities *)
+(* uses associations to represent the monitor *)
+(* units are cm, degrees, and pixels throughout *)
+
+
+(* Implementation of the package *)
+
+
+(* ::Text:: *)
+(*We'll just do this in x axis for now... but should be better than all that*)
+
+
+PixelsPerCM[mon_]:=mon["xres"]/mon["xsize"]
+
+
+CMPerPixel[mon_]:=1/PixelsPerCM[mon]
+
+
+DegreesPerCM[distance_,length_:1.0]:=ArcTan[distance,length]/Degree
+
+
+CMPerDegree[distance_,length_:1.0]:=1/DegreesPerCM[distance,length]
+
+
+DegreesPerPixel[mon_,vp_]:=DegreesPerCM[vp]/PixelsPerCM[mon]
+
+
+DegreesPerPixel[mon_]:=DegreesPerCM[mon["distance"]]/PixelsPerCM[mon]
+
+
+PixelsPerDegree[mon_,vp_]:=1/DegreesPerPixel[mon,vp]
+
+
+PixelsPerDegree[mon_]:=1/DegreesPerPixel[mon,mon["distance"]]
+
+
+(* this shit makes me crazy *)
+
+
+CartesianToMonitor[mon_,p_]:={p[[1]],mon["yres"]-p[[2]]}
+
+
+(* row,col *)
+
+
+MonitorToImage[mon_,p_]:={mon["yres"]-p[[2]],p[[1]]}
+
+
+(* Note this is POSITION not size!!! y inverted! Screen space *)
+
+
+MonitorToDegrees[mon_,p_]:=(CartesianToMonitor[mon,p]-{mon["xres"],mon["yres"]}/2)/PixelsPerDegree[mon]
+
+
+DegreesToMonitor[mon_,va_]:=CartesianToMonitor[mon,(va*PixelsPerDegree[mon])+({mon["xres"],mon["yres"]}/2)]
diff --git a/MonitorUtilities/Documentation/English/Guides/MonitorUtilities.nb b/MonitorUtilities/Documentation/English/Guides/MonitorUtilities.nb
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:127919a4ad44ceb24165f3dcfcd436c6c5d87b2e679a3ad219d1cd6102527796
+size 417164
diff --git a/MonitorUtilities/Documentation/icon.png b/MonitorUtilities/Documentation/icon.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24b5a9f55f8334bbabffd0c96cc3922515be5c38f209bbbbaea866f2fe76a847
+size 221727
diff --git a/MonitorUtilities/Kernel/init.wl b/MonitorUtilities/Kernel/init.wl
diff --git a/MonitorUtilities/MonitorUtilities.wl b/MonitorUtilities/MonitorUtilities.wl
@@ -0,0 +1,29 @@
+(* As borrowed from Arnoud's templates *)
+
+PrintTemporary["Loading ",ToString[Length[Names["MonitorUtilities`*"]]], " MonitorUtilities functions"];
+
+BeginPackage["MonitorUtilities`",{"PacletManager`"}];
+
+Get[FileNameJoin[{DirectoryName[$InputFileName],"Usage.wl"}]];
+
+Begin["`Private`"];
+
+Module[{files},
+
+  (* load in any session *)
+  files={"Globals.wl","Conversions.wl"};
+
+  Map[Get[FileNameJoin[{DirectoryName[$InputFileName], #}]] &, files];
+
+  (* only load in a notebook session *)
+(*
+  If[ Head[$FrontEnd] === FrontEndObject,
+    files = {"Dock.wl","Notebook.wl"};
+    Map[ Get[ FileNameJoin[{DirectoryName[$InputFileName], #}] ] &, files ];
+  ]
+*)
+
+];
+
+End[];
+EndPackage[];
diff --git a/MonitorUtilities/PacletInfo.m b/MonitorUtilities/PacletInfo.m
@@ -0,0 +1,36 @@
+Paclet[
+	Name -> "MonitorUtilities",
+	Description -> "Tools for monitor / viewing calculations",
+	Creator -> "Flip Phillips <flip@skidmore.edu>",
+	Publisher -> "Skidmore Vision Lab",
+	Copyright -> "1997- Flip Phillips",
+	License -> "MIT",
+	Version -> "1.2.0",
+	BuildNumber -> "17",
+	MathematicaVersion -> "11.2+",
+	URL -> "https://github.com/flipphillips/MonitorUtilities",
+	Thumbnail -> "Documentation/icon.png",
+	Loading -> Automatic,
+	Extensions -> {
+	 { "Documentation", 
+			MainPage -> "Guides/MonitorUtilities", 
+			Language -> "English"},
+	 { "Kernel", 
+		Symbols -> {
+			(* globals *)
+			"MonitorUtilities`$MonitorUtilitiesVersion","MonitorUtilities`$MonitorUtilitiesDebug",
+
+			"MonitorUtilities`PixelsPerCM",
+			"MonitorUtilities`CMPerPixel",
+			"MonitorUtilities`DegreesPerCM",
+			"MonitorUtilities`CMPerDegree",
+			"MonitorUtilities`DegreesPerPixel",
+			"MonitorUtilities`PixelsPerDegree",
+			"MonitorUtilities`CartesianToMonitor",
+			"MonitorUtilities`MonitorToImage",
+			"MonitorUtilities`MonitorToDegrees",
+			"MonitorUtilities`DegreesToMonitor"
+		},
+	 Context -> {"MonitorUtilities`"} }
+	}
+]
diff --git a/MonitorUtilities/Usage.wl b/MonitorUtilities/Usage.wl
@@ -0,0 +1,30 @@
+(* ::Package:: *)
+
+
+(* ::Section:: *)
+(*Automatically Generated*)
+
+
+$MonitorUtilitiesVersion::usage = "$MonitorUtilitiesVersion gives its best guess as to the version we're using.";
+$MonitorUtilitiesDebug::usage = "$MonitorUtilitiesDebug let's us know if the package was built with any debugging tools.";
+
+
+(* MonitorUtilities::usage="A package for doing monitor computation. Needs an association with xres,yres,xsize,ysize, and distance defined." *)
+
+
+PixelsPerCM::usage="PixelsPerCM[mon] returns pixels per centimeter for the given mon."
+CMPerPixel::usage="CMPerPixel[mon] returns centimeters per pixel for mon."
+
+
+DegreesPerCM::usage="DegreesPerCM[distance] gives the degrees per 1 centimeter at a particular distance. Optionally, DegreesPerCM[distance,length] allows specification of the length on the screen."
+CMPerDegree::usage="CMPerDegree[distance] gives the centimeters, on the screen."
+
+
+DegreesPerPixel::usage="DegreesPerPixel[mon] gives the given degrees per pixel for monitor mon. DegreesPerPixel[mon,vp] at viewpoint vp."
+PixelsPerDegree::usage="PixelsPerDegree[mon] or PixelsPerDegree[mon,vp]"
+
+
+CartesianToMonitor::usage="CartesianToMonitor[mon,p] projects p onto monitor space."
+MonitorToImage::usage="MonitorToImage[mon,p] projects monitor position to image space {row,col} style."
+MonitorToDegrees::usage="MonitorToDegrees[mon,p] projects monitor position degrees."
+DegreesToMonitor::usage="DegreesToMonitor[mon,va] projects a point at va to monitor space."
diff --git a/build.wls b/build.wls
@@ -0,0 +1,55 @@
+#!/usr/bin/env wolframscript
+#
+# paclet builder
+#
+
+(* gerbils *)
+$packageName="MonitorUtilities";
+$versionFile="version.json";
+$globalsFile="Globals.wl";
+
+directory = Directory[];
+pacletDirectory = FileNameJoin[{directory, $packageName}];
+
+Print["Building from: ", directory];
+
+(* bump build *)
+VersionBumpBuild[directory];
+
+(* globals *)
+Unprotect[{$MonitorUtilitiesDebug,$MonitorUtilitiesVersion}]
+$MonitorUtilitiesDebug=False;
+$MonitorUtilitiesVersion=VersionString[directory,"Build"->True];
+
+(* create global file *)
+gfile=FileNameJoin[{directory,$packageName,$globalsFile}];
+If[FileExistsQ[gfile], DeleteFile[gfile]];
+Save[gfile, {$MonitorUtilitiesDebug, $MonitorUtilitiesVersion}];
+
+(* delete old paclet *)
+files = FileNames["*.paclet", directory];
+Print["Found paclets (to be deleted): ", files];
+DeleteFile /@ files;
+
+(* build new paclet *)
+Print["Building new paclet"];
+UpdatePacletFile[pacletDirectory,directory];
+paclet = PackPaclet[pacletDirectory];
+Print["New paclet: ", paclet];
+
+paclets = PacletFind[$packageName];
+Print["Found the following old paclets (uninstalling): ", Map[ #["Location"]&, paclets]];
+Map[ PacletUninstall, paclets ];
+
+
+(* install new paclet *)
+Print["Installing new paclet"]
+PacletInstall[paclet, IgnoreVersion -> True];
+
+(* Build wiki docs *)
+wikidir=FileNameJoin[{"..",$packageName<>".wiki"}];
+
+Print["Building wiki at ",wikidir]
+BuildWikiDocumentation[wikidir,$packageName];
+
+Print["Done"]
diff --git a/icon.jpg b/icon.jpg
diff --git a/icon.png b/icon.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24b5a9f55f8334bbabffd0c96cc3922515be5c38f209bbbbaea866f2fe76a847
+size 221727
diff --git a/install.wls b/install.wls
@@ -0,0 +1,24 @@
+#!/usr/bin/env wolframscript
+#
+# paclet installer
+#
+
+(* gerbils *)
+$packageName="MonitorUtilities";
+$versionFile="version.json";
+$globalsFile="Globals.wl";
+
+directory = Directory[];
+pacletDirectory = FileNameJoin[{directory, $packageName}];
+
+Print["Installing from: ", directory];
+
+paclets = PacletFind[$packageName];
+Print["Found the following old paclets (uninstalling): ", Map[ #["Location"]&, paclets]];
+Map[ PacletUninstall, paclets ];
+
+(* install new paclet *)
+Print["Installing new paclet"]
+PacletInstall[FileNames["*.paclet", directory], IgnoreVersion -> True];
+
+Print["Done"]
diff --git a/version.json b/version.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+*.paclet`
	`2`	`+.DS_Store`
	`3`	`+MonitorUtilities/Globals.wl`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:127919a4ad44ceb24165f3dcfcd436c6c5d87b2e679a3ad219d1cd6102527796`
	`3`	`+size 417164`