Merge branch 'master' of https://github.com/vasilsaroka/TBpack

README.md

@@ -6,32 +6,90 @@
 # TBpack
 Tight-binding calculations in Mathematica
 
-## Installation
+## Installation guide
 
- - [Download the latest release](https://github.com/vasilsaroka/TBpack/releases), distributed as a `.paclet` file, and install it using the `PacletInstall` function in Mathematica:
+ - The automated installation option for Mathematica 10.0+ is to use the following function:
+
+        InstallTBpack[] := Block[{jsonreleases, info, url, message,tempfile,fpath},
+        jsonreleases = Import["https://api.github.com/repos/vasilsaroka/TBpack/releases","JSON"];
+        If[jsonreleases === $Failed, Return[$Failed]];
+        info = "Downloading TBpack " <> First@Lookup[jsonreleases, "tag_name"];
+        If[
+           $Notebooks,
+           PrintTemporary@Row[{info,ProgressIndicator[Appearance -> "Percolate"]},Frame -> True,RoundingRadius -> 9], 
+           Print[info <> "..."]
+        ];
+        url = First@Lookup[First[Lookup[jsonreleases, "assets"]],"browser_download_url"];
+        message = "TBpack is succefully installed.";
+        If[
+   	         $VersionNumber >= 12.1,
+   	         Check[PacletInstall[url, ForceVersionInstall -> True],Return[$Failed]];
+   	         Print[message],
+   	         If[
+    		   $VersionNumber >= 11.0,
+                  tempfile = FileNameJoin[{$TemporaryDirectory,FileNameTake[url]}];
+                  Check[fpath = URLDownload[url, tempfile],Return[$Failed]];
+                  If[
+                      FileExistsQ[fpath],
+                      Check[PacletManager\`PacletInstall[fpath,"IgnoreVersion" -> True],Return[$Failed]];
+                      DeleteFile[fpath];
+                      Print[message],
+                      $Failed
+     		   ],
+    		   If[
+                      $VersionNumber >= 10.0,
+                      tempfile = FileNameJoin[{$TemporaryDirectory,FileNameTake[url]}];
+                      Check[fpath = URLSave[url,tempfile],Return[$Failed]];
+                      If[
+                           FileExistsQ[fpath],
+                           Check[PacletManager\`PacletInstall[fpath,"IgnoreVersion" -> True],Return[$Failed]];
+                           DeleteFile[fpath];
+                           Print[message],
+                           $Failed
+                      ],
+                      $Failed
+                 ](* end If *)
+              ](* end If *)
+          ](* end If  *)
+        ](* end Block *)
+
+   Copy-paste the above function into a Mathematica notebook cell. Evaluate the cell to make the definition of this function known to Mathematica. In the next cell type and evaluate `InstallTBpack[]`. 
+
+ - An alternative manual intallation option for Mathematica 10.0+ is the following. [Download the latest release](https://github.com/vasilsaroka/TBpack/releases), distributed as a `.paclet` file, and install it using the `PacletInstall` function in Mathematica:
 
         Needs["PacletManager`"]
         PacletInstall["path2paclet"]
         
    Insert `path2paclet` via Mathematica's Insert → File Path... menu command.
 
-   In Mathematica 12.1+ ``PacletInstall["url"]`` can be used for the installation straight away:
+ - In Mathematica 12.1+ ``PacletInstall["url"]`` can be used for the installation straight away:
 
         PacletInstall["https://github.com/vasilsaroka/TBpack/releases/download/v<version>/TBpack-<version>.paclet"]  
    where `<version>` stands for the latest version of the application. For example,
 
        PacletInstall["https://github.com/vasilsaroka/TBpack/releases/download/v0.2.0/TBpack-0.2.0.paclet"]
 
-
+## Demo
  - Evaluate ``<<TBpack` `` to load the application into the Mathematica session.
  - Test TBpack using `AtomicStructure[Nanotube[10, 10]]`.
  - Test MaTeX using `MaTeX["x^2"]`.
+ - Test CustomTicks using `Plot[Sin[x], {x, 0, 3}, Ticks -> {LinTicks[-1, 3, 1, 5], LinTicks[0, 1, 1, 5]}]`.
+ - Test MaTeX and CustomTicks altogether using 
+
+       Plot[Sin[x], {x, -1, 3}, 
+            Axes -> {MaTeX["x"],MaTeX["\sin(x)"]},
+            AxesStyle -> BlackFrame, 
+            Ticks -> {
+            LinTicks[-1, 3, 1, 5, MinorTickLength -> 0.015, MajorTickLength -> 0.025], 
+            LinTicks[-1, 1, 1, 5, MinorTickLength -> 0.015, MajorTickLength -> 0.025]
+            }
+       ]
 
    Packages [MaTeX](https://github.com/szhorvat/MaTeX/releases) by Szabolcs Horvát and [CustomTicks](https://library.wolfram.com/infocenter/Demos/5599/) by Mark A. Caprio  are integral parts of `TBpack`.
 
-   Compilation to C code is used in TBpack to speed up optical absorption spectra calculations. See [how to make Mathematica working with C compiler on Windows](https://sites.google.com/site/sarokavasil/wolfram-mathematica). If compiler is not available Mathematica will run uncompiled function.
-
  - Open the documentation center and search for "Hamiltonian" to get started.
+
+ <b>Note:</b> Compilation to C code is used in TBpack to speed up optical absorption spectra calculations. See [how to make Mathematica working with C compiler on Windows](https://sites.google.com/site/sarokavasil/wolfram-mathematica). If compiler is not available Mathematica will run uncompiled function.
 
 ## Supporting the project
    TBpack is free to use and distribute and will stay so. However, since it is developed in my own time consider supporting the project to help me to explain my wife why I should spend our weekends on this :)