Added documentation for modeller module

hng · Mar 26, 2015 · 08f7c6c · 08f7c6c
1 parent 98d8ee2
commit 08f7c6c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/modeller.md b/docs/modeller.md
@@ -0,0 +1,11 @@
+# Modeller
+
+## Exported functions
+
+``
+    function gen_script(name::String)``
+
+Generates Julia scripts for MODELLER.
+name: The name of the script (minus the extension), e.g. "build_profile"
+These scripts are based on the basic example scripts from the MODELLER website.
+Scripts are generated in the current working directory. You can find all scripts that can be generated in src/MODELLER/modeller-basic-example-julia .
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,6 +8,7 @@ pages:
 - ['webblast.md', 'WebBLAST - NCBI/EBI BLAST Web-API']
 - ['kabsch.md', 'Kabsch - Kabsch Algorithm']
 - ['mafft.md', 'MAFFT - Julia API for MAFFT commandline tool for sequence alignment']
+- ['modeller.md', 'Modeller - Functions and scripts to use MODELLER with Julia']
 - ['pdb.md', 'PDB - PDB Utilities']
 - ['plot.md', 'MatrixPlot - Plotting Utilities']