TEP file creation (#58)

* Add res2tep

* Add code + docs for res2tep

* Add additiona methods for res2tep and add tests

* Relax compat on Dates

* Relax compat on standard libraries

* Update downgrade_CI.yml

* Update Project.toml to remove compat entries for standard libs

* Update Project.toml NearestNeighbors compat entry

For downgrade check

* Update Project.toml OffsetArrays compat entry

Project.toml

@@ -1,7 +1,7 @@
 name = "PSSFSS"
 uuid = "6b20a5d4-3c6c-44cd-883b-1480592d72be"
 authors = ["Peter Simon <[email protected]>"]
-version = "1.9"
+version = "1.10.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
@@ -29,28 +29,31 @@ Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 SLEEFPirates = "476501e8-09a2-5ece-8869-fb82de89a1fa"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+TicraUtilities = "97d36a8d-cc3e-473e-9421-8a7b112c16eb"
 Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [compat]
+DelimitedFiles = "1.9"
 FFTW = "1.8"
 FileIO = "1.16.2"
-GeoInterface = "1.3.3"
-JLD2 = "0.5.8"
+GeoInterface = "1.3"
+JLD2 = "0.5"
 LibGEOS = "0.9"
-LoggingExtras = "1.0.3"
+LoggingExtras = "1.1"
 MetalSurfaceImpedance = "1.0"
-NearestNeighbors = "0.4.16"
-OffsetArrays = "1.13"
+NearestNeighbors = "0.4.8"
+OffsetArrays = "1.14"
 OhMyThreads = "0.7"
 PkgVersion = "0.3.3"
 PolygonOps = "0.1.2"
 PrecompileTools = "1.2"
-ProgressMeter = "1.9.0"
+ProgressMeter = "1.10"
 RecipesBase = "1.3.4"
 Reexport = "1.2.2"
 SLEEFPirates = "0.6.42"
 StaticArrays = "1.9.2"
+TicraUtilities = "1.1.0"
 Triangulate = "2.3.2"
 Unitful = "1.19.0"
 julia = "1"

README.md

@@ -1,11 +1,11 @@
-# PSSFSS - analysis of polarization and frequency selective surfaces in Julia
+# PSSFSS - Analysis of polarization and frequency selective surfaces in Julia
 
 
 | **Documentation**   |  **Tests**     | **CodeCov**  |
 |:--------:|:---------------:|:-------:|
 |[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://simonp0420.github.io/PSSFSS.jl/stable/manual)  [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://simonp0420.github.io/PSSFSS.jl/dev/manual)| [![CI](https://github.com/simonp0420/PSSFSS.jl/workflows/CI/badge.svg?branch=main)](https://github.com/simonp0420/PSSFSS.jl/actions) | [![codecov.io](https://codecov.io/github/simonp0420/PSSFSS.jl/coverage.svg?branch=main)](https://codecov.io/github/simonp0420/PSSFSS.jl?branch=main) |
 
-`PSSFSS` is a Julia package for analyzing 
+`PSSFSS` is a Julia package for analyzing planar 
 [polarization selective surfaces](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C5&q=polarization+selective+surface&btnG=) (PSSs), [frequency selective surfaces](https://en.wikipedia.org/wiki/Frequency_selective_surface) (FSSs), 
 [reflectarray](https://en.wikipedia.org/wiki/Reflectarray_antennahttps://en.wikipedia.org/wiki/Reflectarray_antenna) elements, 
 [radomes](https://en.wikipedia.org/wiki/Radome), and similar structures.  It is intended to be useful to antenna design engineers and others who work in applied electromagnetic engineering.
@@ -16,8 +16,8 @@ and their associated triangulations can be conveniently visualized using Julia's
 [`Plots`](https://github.com/JuliaPlots/Plots.jl) package. After also specifying the scan angles or
 unit cell incremental phasings, frequencies to be analyzed, and optionally selecting performance parameters to be written
 to [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) file(s), 
-the user then invokes the `analyze` function to perform the analysis.  Post-processing and plotting of results can be
-performed in the same analysis script using the immensely powerful Julia programming language.
+the user then invokes the `analyze` function to perform the analysis.  Post-processing and plotting of results can be performed in the same analysis script using the immensely powerful 
+[Julia programming language](https://julialang.org/).
 
 
 ## Features
@@ -42,6 +42,7 @@ performed in the same analysis script using the immensely powerful Julia program
     * Delta insertion phase delay (ΔIPD)
     * Delta insertion loss (ΔIL)
     * Axial ratio 
+* Analysis results can be exported to TICRA-compatible TEP (tabulated electrical properties) files.
 
 ## Limitations
 
@@ -61,34 +62,38 @@ performed in the same analysis script using the immensely powerful Julia program
   unstructured mesh on these elements, specify `structuredtri = false` in the constructor argument list.
 - Version 1.4: New, chiral `manji` element added.
 - Version 1.5: `sinuous` element added.
-- Version 1.6: Added `export_sheet` for exporting `RWGSheet` triangulations to STL-format CAD files.
+- Version 1.6: Added `export_sheet` for exporting FSS/PSS sheets to STL-format CAD files.
 - Version 1.7: Function `extract_result_file` is deprecated in favor of a new method for `extract_result`.
 - Version 1.8: Improved multi-threading in matrix fill functions.
 - Version 1.9: Added `orient` keyword to `rectstrip`, allowing geometry rotation within the stationary unit cell.
+- Version 1.10: New `res2tep` function allows saving results in the form of a TICRA-compatible TEP 
+  (tabulated electrical properties) file.
 
 ## Installation
-You can obtain PSSFSS using Julia's Pkg REPL-mode (hitting `]` as the first character at the command prompt):
+You can obtain and install PSSFSS using Julia's Pkg REPL-mode (hitting `]` as the first character at the command prompt):
 
 ```julia
 (@v1.8) pkg> add PSSFSS
 ```
 
-(and then hitting `<Backspace>` to return to the REPL) or with `import Pkg; Pkg.add("PSSFSS")`.
+(and then hitting `<Backspace>` to return to the REPL) or with 
+```julia
+using Pkg: Pkg
+Pkg.add("PSSFSS")
+```
 
 
 ## Documentation
 - The theory documentation is [here](https://github.com/simonp0420/PSSFSS.jl/blob/main/docs/TheoryDocs/theorydoc.pdf)
 - The user manual is [here](https://simonp0420.github.io/PSSFSS.jl/stable/manual)
-- If you prefer interactive documentation using Jupyter notebooks, the user documentation in the form of notebooks is
-  [here](https://github.com/simonp0420/PSSFSS.jl/blob/main/docs/notebooks)
 
 ## Citing PSSFSS
 If you use PSSFSS for a scientific publication, please cite the 2024
 [ACES Journal paper](https://journals.riverpublishers.com/index.php/ACES/article/view/22443) in the following way:
 
 > P. S. Simon, “PSSFSS—An Open-source Code for Analysis of Polarization and Frequency Selective Surfaces”, ACES Journal, vol. 39, no. 02, pp. 139–148, Feb. 2024.
 
-BibTeX entry:
+or use this BibTeX entry:
 
 ```bib
 @article{simo:24,

docs/PSS_&_FSS_Element_Gallery/config.json

@@ -1,3 +1,4 @@
 {
+    "title": "PSS & FSS Element Gallery",
     "theme": "bulmagrid"
 }

docs/PSS_&_FSS_Element_Gallery/index.md

@@ -0,0 +1,2 @@
+# PSS & FSS Element Gallery
+{{{democards}}}

docs/Project.toml

@@ -7,5 +7,5 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 
 [compat]
 DemoCards = "0.5.2"
-Documenter = "0.27.25"
+Documenter = "1"
 Literate = "2.15.0, 2.15.1"

docs/literate/compile.jl

@@ -10,37 +10,30 @@ examples_list = ["symmetric_strip.jl", "resistive_square_patch.jl",
                  "cross_on_dielectric_substrate.jl", 
                  "square_loop_absorber.jl", "flexible_absorber.jl", "splitringexample.jl", "reflectarray_example.jl",
                  "band_pass_filter.jl", "cpss1.jl", "cpss_optimization.jl", "cpss2.jl", "splitring_cpss.jl",
-                 "angular_ss_example.jl"]
+                 "angular_ss_example.jl", "tepfile_creation_example.jl"]
 
-# Adds examples as subsections to the Examples page:
-function replace_unknowns(str)
-    findstr = """EditURL = "<unknown>"""
-    replace(str, findstr => """EditURL = "https://github.com/simonp0420/PSSFSS.jl/tree/main/docs/literate""")
-end
 
 flist = ["manual.jl"]
 for file in flist
-    Literate.markdown(file, "../src", codefence=("```@repl manual" => "```"), credit=false,
-    postprocess=replace_unknowns)
+    Literate.markdown(file, "../src", codefence=("```@repl manual" => "```"), credit=false)
     #Literate.notebook(file, "../notebooks", preprocess=notebook_filter, execute=false)
     Literate.notebook(file, "../notebooks", execute=false)
 end
 
 for (i,file) in enumerate(examples_list)
     fnpre = splitext(file)[1]
-    Literate.markdown(file, ".", credit=false)
+    Literate.markdown(file, "../src", credit=false)
     #Literate.notebook(file, "../notebooks", preprocess=notebook_filter, execute=false)
     Literate.notebook(file, "../notebooks", execute=false)
 end
 
 function postinclude(str)
-  str = replace_unknowns(str)
   for file in examples_list
-    mdfile = splitext(file)[1] * ".md"
-    str *= replace_unknowns(read(mdfile, String))
-    #rm(mdfile)
+    mdfile = joinpath("..", "src", splitext(file)[1] * ".md")
+    str *= read(mdfile, String)
+    rm(mdfile)
   end
-  str
+  return str
 end
 
 Literate.markdown("examples.jl", "../src", postprocess=postinclude, credit=false)