diff convert_detect_formats/rings_kcf_to_image/README_convertKCF.md @ 0:89592faa2875 draft

Uploaded
author chrisb
date Wed, 23 Mar 2016 14:35:56 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/convert_detect_formats/rings_kcf_to_image/README_convertKCF.md	Wed Mar 23 14:35:56 2016 -0400
@@ -0,0 +1,30 @@
+
+[TOC]
+
+# 1. post_kcf_to_image.py
+
+**This tool reads a kcf file (containing glycans) and returns images in CFG notation using the server at RINGS. Images are presented in html and the first kcf glycan is returned as a png.**
+
+## Works with Galaxy?
+Yes. see [post_kcf_to_image.xml](post_kcf_to_image.xml)
+
+
+## Command line usage
+```
+../../virtualpy/bin/activate
+python post_kcf_to_image.py $input $pngoutput $htmloutput
+```
+
+## Help
+```
+../../virtualpy/bin/activate
+python post_kcf_to_image.py -h
+```
+
+## Unit Testing?
+Yes. Use test_rings_kcf_to_image.py
+
+```
+../../virtualpy/bin/activate
+python test_rings_kcf_to_image.py
+```