diff --git a/README.md b/README.md index f689101..ebf7ae3 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,20 @@ Crow has three tabs: __Pre-Pull__, __Pull__, and __Present__. __Pre-Pull__ ident Designed by Jackson Burns at the University of Delaware Donald Watson Lab in 2019, coded in Python in 2020. +## How to use Crow +Please see this video for instructions: +https://www.jacksonwarnerburns.com/crow + ## Setup Data is retrieved by parsing XML files output by the software on the High Throughput Experimentation instrument. For example, our setup uses an Agilent GC and their software to run experiments and calculate eluate peak areas. A conda environment file (.yml) lists the required packages and versions needed to run Crow. -To configure Crow to work for your setup, there are a few small changes to make: -* change the filepath in PrePull "Search Server by Name" callback to the location of your network drive where xml data are stored -* change the indexing in Pull to match the location of the peak data in your particular instrument's output files +To configure Crow to work for your setup, there are a few small changes to make in __globals_GC.py__: +* change the __rawdatapath__ variable to the filepath of a local/network location where data files are stored +* change the __exportdatapath__ variable to the filepath where data files created by __Pull__ should be saved + +The indexing of the XML files in __Pull_GC.py line 48__ is built around our lab's particular GC and its configuration. Change this to match the location of the peak data in your particular instrument's output files. ## Support -If you need help with setting up Crow, finding out how to retrieve data from your HTE instrument, or you find this program at all helpful, send me a message here: jburnsky@udel.edu with the subject line "Crow" +If you need help with setting up Crow, finding out how to retrieve data from your HTE instrument, or you find this program at all helpful, send me a message here: jburnsky@udel.edu with the subject line "Crow" and your name.