Merge branch 'master' of https://github.com/hzarei4/SyntheticObjects.jl

hzarei4 · Jun 14, 2024 · 0eb4435 · 0eb4435
2 parents 9d6a576 + 67c4ac0
commit 0eb4435
Show file tree

Hide file tree

Showing 13 changed files with 1,169 additions and 70 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,10 +1,12 @@
 name: CI
 on:
+  pull_request:
+    branches:
+      - master
   push:
     branches:
-      - main
-    tags: ['*']
-  pull_request:
+      - master
+    tags: '*'
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
@@ -20,7 +22,7 @@ jobs:
         version:
           - '1'
         os:
-          - ubuntu-latest
+          - [ubuntu-latest] 
         arch:
           - x64
     steps:
@@ -47,7 +49,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: "1"
+          version: "1.9"
       - uses: julia-actions/julia-docdeploy@releases/v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/README.md b/README.md
@@ -28,3 +28,16 @@ arr_pollen = pollen3D((256, 256, 256));
 arr_filaments = filaments3D((100,100,100); rel_theta=0, rand_offset=(0.2, 0.2, 0))
 ```
 
+
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-orange.svg 
+[docs-dev-url]: https://hzarei4.github.io/SyntheticObjects.jl/dev/ 
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg 
+[docs-stable-url]: https://hzarei4.github.io/SyntheticObjects.jl/stable/
+
+[codecov-img]: https://codecov.io/gh/hzarei4/SyntheticObjects.jl/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/hzarei4/SyntheticObjects.jl
+
+[CI-img]: https://github.com/hzarei4/SyntheticObjects.jl/workflows/CI/badge.svg
+[CI-url]: https://github.com/hzarei4/SyntheticObjects.jl/actions?query=workflow%3ACI 
diff --git a/docs/doc_server.sh b/docs/doc_server.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+python3 -m http.server --bind localhost
diff --git a/docs/generate_objects.jl b/docs/generate_objects.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -6,12 +6,9 @@ makedocs(sitename="SyntheticObjects.jl",
         modules = [SyntheticObjects]
         , pages = Any[
             "SyntheticObjects.jl" => "index.md",
+            "API" => "function_references/objects.md",
         ]
-        , 
-        #make = Documenter.make_julia_cmd()
         )
 
 
-deploydocs(repo = "github.com/hzarei4/SyntheticObjects.jl.git",
-            target = "gh-pages",
-            )
+deploydocs(repo = "github.com/hzarei4/SyntheticObjects.jl.git")
diff --git a/docs/src/assets/arr_filaments.png b/docs/src/assets/arr_filaments.png
diff --git a/docs/src/assets/arr_pollen.png b/docs/src/assets/arr_pollen.png
diff --git a/docs/src/assets/arr_resolution_test.png b/docs/src/assets/arr_resolution_test.png
diff --git a/docs/src/function_references/objects.md b/docs/src/function_references/objects.md
@@ -0,0 +1,15 @@
+# Objects
+```@docs
+pollen3D
+object_3D
+filaments3D 
+draw_sphere!
+draw_line!
+filaments3D!
+spokes_object 
+hollow_sphere! 
+resolution_test
+hollow_sphere  
+annotation_3D!
+matrix_read
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,50 +1,42 @@
-# SyntheticObjects.jl Documentation
+# SyntheticObjects.jl
 
-```@docs
-pollen3D(x)
-```
 
-```@docs
-object_3D
-```
+This package creates several synthetic objects in Julia to further process in the image processing routines.
 
-```@docs
-filaments3D 
-```
+## Overview
+Using this package, user can generate different objetcs for the pupose of image processing. This package contains 2D as well as 3D samples
+of different objects (Numbers, Alphabets, and objects).
 
-```@docs
-draw_sphere!
-```
 
-```@docs
-annotation_3D!
-```
+## Installation
+`SyntheticObjects.jl` can be installed using the command:
 
-```@docs
-draw_line!
+```julia
+julia> ] add SyntheticObjects
 ```
 
-```@docs
-filaments3D!
-```
 
+## Examples
 
-```@docs
-matrix_read
-```
+```julia
+julia> using SyntheticObjects
 
-```@docs
-spokes_object 
-```
+# this generates a pollen grain object array
+arr_pollen = pollen3D((256, 256, 256));
 
-```@docs
-hollow_sphere! 
-```
 
-```@docs
-resolution_offset 
+# a set of filaments in 3D:
+arr_filaments = filaments3D((256,256,256))
+
+# and so on ...     
 ```
+### Image of the pollen object (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_pollen.png)
+
+### Image of the filaments (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_filaments.png)
+
+
 
-```@docs
-hollow_sphere  
-```
+### Image of the resolution test (plotted using [`View5D.jl`](https://github.com/RainerHeintzmann/View5D.jl) package)
+![](assets/arr_resolution_test.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/bin/bash

		python3 -m http.server --bind localhost