Feat and Additions

.github/workflows/CI.yml

@@ -43,7 +43,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1'
+          version: '1.9'
+      - uses: julia-actions/cache@v1
+        with:
+          cache-registries: "true"
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-docdeploy@v1
         env:

docs/Manifest.toml

@@ -1,8 +1,8 @@
 # This file is machine-generated - editing it directly is not advised
 
-julia_version = "1.8.0"
+julia_version = "1.8.5"
 manifest_format = "2.0"
-project_hash = "a66165f6da81458613938be0d3cf4835e0b4522b"
+project_hash = "c314d07c33c737c2dea5d86662f8061ff527d5f7"
 
 [[deps.ANSIColoredPrinters]]
 git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
@@ -18,15 +18,15 @@ uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
 
 [[deps.DocStringExtensions]]
 deps = ["LibGit2"]
-git-tree-sha1 = "5158c2b41018c5f7eb1470d558127ac274eca0c9"
+git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
 uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
-version = "0.9.1"
+version = "0.9.3"
 
 [[deps.Documenter]]
 deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
-git-tree-sha1 = "6030186b00a38e9d0434518627426570aac2ef95"
+git-tree-sha1 = "58fea7c536acd71f3eef6be3b21c0df5f3df88fd"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-version = "0.27.23"
+version = "0.27.24"
 
 [[deps.IOCapture]]
 deps = ["Logging", "Random"]
@@ -46,8 +46,8 @@ version = "0.21.3"
 
 [[deps.JuliaUtils]]
 path = ".."
-uuid = "5394660d-8fe9-41aa-abe5-b2992337cf4a"
-version = "0.1.0"
+uuid = "e738e926-3d3f-4c6c-9019-dd7448bc78fc"
+version = "1.0.0"
 
 [[deps.LibGit2]]
 deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
@@ -68,10 +68,16 @@ uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
 version = "1.2.0"
 
 [[deps.Parsers]]
-deps = ["Dates"]
-git-tree-sha1 = "3d5bf43e3e8b412656404ed9466f1dcbf7c50269"
+deps = ["Dates", "SnoopPrecompile"]
+git-tree-sha1 = "478ac6c952fddd4399e71d4779797c538d0ff2bf"
 uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
-version = "2.4.0"
+version = "2.5.8"
+
+[[deps.Preferences]]
+deps = ["TOML"]
+git-tree-sha1 = "47e5f437cc0e7ef2ce8406ce1e7e24d44915f88d"
+uuid = "21216c6a-2e73-6563-6e65-726566657250"
+version = "1.3.0"
 
 [[deps.Printf]]
 deps = ["Unicode"]
@@ -92,9 +98,20 @@ version = "0.7.0"
 [[deps.Serialization]]
 uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 
+[[deps.SnoopPrecompile]]
+deps = ["Preferences"]
+git-tree-sha1 = "e760a70afdcd461cf01a575947738d359234665c"
+uuid = "66db9d55-30c0-4569-8b51-7e840670fc0c"
+version = "1.0.3"
+
 [[deps.Sockets]]
 uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
 
+[[deps.TOML]]
+deps = ["Dates"]
+uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
+version = "1.0.0"
+
 [[deps.Test]]
 deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
 uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

docs/make.jl

@@ -15,7 +15,26 @@ makedocs(;
         assets=String[],
     ),
     pages=[
-        "Home" => "index.md",
+    "Home" => "index.md",
+	"Core utility functions" => [ 
+        "I/O"=> "core/io.md",
+        "Space"=> "core/space.md",
+        "Periodic"=> "core/periodic.md",
+        "Physics"=> "core/physics.md",
+        "Defects"=> "core/defects.md",
+        "Spectrum"=> "core/spectrum.md",
+        "Interpolations"=> "core/interpolations.md"
+        ],
+	"Ploting Utilities" => [
+        "Makie"    => "ploting/makie.md",
+        "PyPlot"   => "ploting/pyplot.md"
+        ],
+	"Macros" =>  "macros/macros.md",
+    "Library" => [
+        "Public" => "library/public.md", 
+        "Internals" => "library/internals.md",
+        "Glossary" => "library/glossary.md"
+        ]
     ],
 )
 

docs/src/core/defects.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["defects.jl"]
+```

docs/src/core/interpolations.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["interpolations.jl"]
+```

docs/src/core/io.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["io.jl"]
+```

docs/src/core/periodic.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["periodic.jl"]
+```

docs/src/core/physics.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["physics.jl"]
+```

docs/src/core/space.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["space.jl"]
+```

docs/src/core/spectrum.md

@@ -0,0 +1,4 @@
+```@autodocs
+ Modules = [JuliaUtils]
+ Pages   = ["spectrum.jl"]
+```

docs/src/index.md

@@ -4,11 +4,20 @@ CurrentModule = JuliaUtils
 
 # JuliaUtils
 
-Documentation for [JuliaUtils](https://github.com/navdeeprana/JuliaUtils.jl).
+Documentation for [JuliaUtils](https://github.com/pankajpopli/JuliaUtils.jl).
+
+## Overview
+
+## Instalation
+
+Install this package by using
+add github_repo_url
+
+
+## Devlopers
+
+This repo is currently being devloped by Navdeep Rana and Pankaj Popli.
+
+## Cite
 
-```@index
-```
 
-```@autodocs
-Modules = [JuliaUtils]
-```

docs/src/library/glossary.md

@@ -0,0 +1,12 @@
+## Modules
+
+```@autodocs
+Modules = [JuliaUtils,JuliaUtils.MakieUtils,JuliaUtils.PyPlotUtils]
+Order  = [:module]
+```
+
+
+## Index of all functions
+```@index
+Modules = [JuliaUtils,JuliaUtils.PyPlotUtils,JuliaUtils.MakieUtils]
+```

docs/src/library/internals.md

@@ -0,0 +1,3 @@
+## Mention any internal details here
+
+I have created this file in spirit of other published documentations. Should remove if not needed.

docs/src/library/public.md

@@ -0,0 +1,3 @@
+## Any public details about the package
+
+I have created this file in spirit of other published documentations. Should remove if not needed.

docs/src/macros/macros.md

@@ -0,0 +1,7 @@
+## Custom macros definitions
+
+```@autodocs
+Modules = [JuliaUtils,JuliaUtils.MakieUtils,JuliaUtils.PyPlotUtils]
+Order = [:macro]
+Pages   = ["macros.jl"]
+```

docs/src/ploting/makie.md

@@ -0,0 +1,5 @@
+```@autodocs
+ Modules = [JuliaUtils.MakieUtils]
+Pages   = ["makie.jl"]
+Order = [:constant,:type,:function,:macro]
+```

docs/src/ploting/pyplot.md

@@ -0,0 +1,5 @@
+```@autodocs
+ Modules = [JuliaUtils.PyPlotUtils]
+ Pages   = ["pyplot.jl"]
+Order = [:constant,:type,:function,:macro]
+```

src/JuliaUtils.jl

@@ -1,54 +1,72 @@
 """
-Main module for `JuliaUtils.jl` -- my julia language utility functions.
-
+Main module for `Julia Useful functions`
 # Exports
 $(EXPORTS)
 """
 module JuliaUtils
+   #core exported functions
+   export read_data,
+      read_xydata,
+      write_data,
+      write_xydata,
+      linspace,
+      logspace,
+      logspacedPick,
+      logspacedPick!,
+      cartesian_mesh,
+      polar_mesh,
+      periodic_distance,
+      aperiodic,
+      defect_vector_field,
+      find_defects,
+      chargeAt,
+      nearest_neighbour_distance,
+      radial_distribution_function,
+      Interp2D,
+      order_parameter,
+      @repeat
 
-export read_data,
-    read_xydata,
-    write_data,
-    write_xydata,
-    linspace,
-    logspaced,
-    cartesian_mesh,
-    polar_mesh,
-    periodic_distance,
-    aperiodic,
-    defect_vector_field,
-    find_defects,
-    charge,
-    nearest_neighbour_distance,
-    radial_distribution_function,
-    @repeat
-
-using DocStringExtensions
-
-include("io.jl")
-include("space.jl")
-include("defects.jl")
-include("physics.jl")
-include("macros.jl")
-
-module PyPlotUtils
+   using DocStringExtensions
+   include("io.jl")
+   include("space.jl")
+   include("defects.jl")
+   include("physics.jl")
+   include("macros.jl")
+   include("interpolations.jl")
+   include("periodic.jl")
+   include("spectrum.jl")
+   include("pyplot.jl")
+   include("makie.jl")
 
-export colors,
-    figax,
-    noticks!,
-    fontsize!,
-    formatter!
+   # include all files recursively from the `src` folder
+   # for (root, dirs, files) in walkdir("src")
+   #    for file in files
+   #       # check if the file is a Julia file
+   #       if endswith(file, ".jl")
+   #          # construct the path to the file
+   #          path = joinpath(root, file)
+   #          # include the file in the module
+   #          Base.include(path)
+   #       end
+   #    end
+   # end
 
-include("pyplot.jl")
 
-end
-
-module MakieUtils
 
-export figax
 
-include("makie.jl")
-
-end
+   # module PyPlotUtils
+   # export colors,
+   #    figax,
+   #    noticks!,
+   #    fontsize!,
+   #    formatter!
+   #    include("pyplot.jl")
+   # end
+
+   # module MakieUtils
+   # using DocStringExtensions
+   # export figax
+   #    include("makie.jl")
+   # end
 
 end