update external api for DECAES v0.4.3

jondeuce · Mar 3, 2022 · 8f08b1e · 8f08b1e · jondeuce · Mar 3, 2022
1 parent 56683dc
commit 8f08b1e
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git a/api/decaes.m b/api/decaes.m
@@ -92,7 +92,7 @@
 % 
 %   Note the separation of the Matlab-specific flags from the DECAES settings file.
 % 
-% This version of decaes.m was written for DECAES v0.4.2.
+% This version of decaes.m was written for DECAES v0.4.3.
 % DECAES was written by Jonathan Doucette ([email protected]).
 % Original MATLAB implementation is by Thomas Prasloski ([email protected]).
 

diff --git a/api/decaes.py b/api/decaes.py
@@ -1,3 +1,24 @@
+"""
+Load the DECAES.jl Julia package from python.
+DECAES.jl will be installed automatically, if necessary.
+
+This module requires the julia Python package to be installed.
+See the following documentation for instructions:
+
+    https://github.com/JuliaPy/pyjulia#quick-usage
+
+Quick usage:
+
+    import decaes
+    decaes.initialize()
+    from decaes import DECAES
+
+    # Call methods from the DECAES module as usual, e.g.
+    DECAES.T2mapSEcorr(image; kwargs...)
+
+This version of decaes.py was written for DECAES v0.4.3.
+"""
+
 import julia
 import os
 import subprocess
@@ -39,13 +60,13 @@ def install(
     # Install DECAES.jl
     decaes_install_script = """try
             @info "Trying to import DECAES..."
-            import DECAES
+            @eval import DECAES
         catch e
             @error "`import DECAES` failed" exception=(e, catch_backtrace())
             @info "Installing DECAES..."
             import Pkg
             Pkg.add("DECAES")
-            import DECAES
+            @eval import DECAES
         end
         """.replace("        ", "")
 

diff --git a/api/decaes.sh b/api/decaes.sh
@@ -16,10 +16,12 @@ parser = argparse.ArgumentParser(
 
     Example:
 
-        Start Julia with 8 threads and run DECAES using parameters specified by the
+        Start Julia with multiple threads and run DECAES using parameters specified by the
         settings file 'decaes_settings_file.txt':
 
-            python decaes.py --threads=8 @/path/to/decaes_settings_file.txt
+            python decaes.py @/path/to/decaes_settings_file.txt
+
+    This version of decaes.sh was written for DECAES v0.4.3.
     """,
     formatter_class = argparse.RawDescriptionHelpFormatter,
 )