comparison COBRAxy/docs/tutorials/galaxy-setup.md @ 492:4ed95023af20 draft

Uploaded
author francesco_lapi
date Tue, 30 Sep 2025 14:02:17 +0000
parents
children
comparison
equal deleted inserted replaced
491:7a413a5ec566 492:4ed95023af20
1 # Galaxy Setup Tutorial
2
3 Learn how to set up a local Galaxy instance with COBRAxy tools for web-based metabolic analysis.
4
5 ## Overview
6
7 This tutorial provides guidance and references to official Galaxy documentation for:
8
9 - Installing Galaxy locally (using official Galaxy guides)
10 - Adding COBRAxy tools to your Galaxy instance
11 - Running COBRAxy analyses through the web interface
12
13 ## Step 1: Install Galaxy Locally
14
15 For installing Galaxy on your local machine, follow the official documentation:
16
17 ### Official Installation Guides
18
19 - **[Galaxy Installation Guide](https://docs.galaxyproject.org/en/master/admin/)**
20
21 - **[Galaxy Quick Start](https://docs.galaxyproject.org/en/master/admin/production.html)**
22
23 - **[Galaxy Training: Admin Track](https://training.galaxyproject.org/training-material/topics/admin/)**
24
25 ### Quick Summary
26
27 1. Clone Galaxy repository: `git clone https://github.com/galaxyproject/galaxy.git`
28 2. Run setup script: `sh run.sh`
29 3. Access at: `http://localhost:8080`
30
31 **Note**: Refer to official documentation for detailed configuration, security settings, and production deployment.
32
33 ## Step 2: Add COBRAxy Tools to Galaxy
34
35 For adding custom tools to Galaxy, refer to the official documentation:
36
37 ### Official Tool Installation Guides
38
39 - **[Adding Tools to Galaxy](https://docs.galaxyproject.org/en/master/admin/tool_panel.html)**
40
41 - **[Tool Development Tutorial](https://training.galaxyproject.org/training-material/topics/dev/)**
42
43 - **[Galaxy Tool Installation](https://planemo.readthedocs.io/en/latest/)**
44
45 ### COBRAxy-Specific Setup
46
47 1. **Copy COBRAxy files** to Galaxy's tools directory:
48 ```bash
49 mkdir -p tools/cobraxy
50 cp /path/to/COBRAxy/*.xml tools/cobraxy/
51 cp /path/to/COBRAxy/*.py tools/cobraxy/
52 cp -r /path/to/COBRAxy/utils tools/cobraxy/
53 cp -r /path/to/COBRAxy/local tools/cobraxy/
54 ```
55
56 2. **Add tools to Galaxy configuration**:
57 Edit `config/tool_conf.xml` and add a COBRAxy section with all tool XML files.
58
59 3. **Restart Galaxy** to load the new tools.
60
61 **Note**: Consult the official Galaxy documentation for detailed instructions on tool installation, dependency management, and troubleshooting.
62
63 ## Step 3: Using COBRAxy in Galaxy
64
65 ### Verify Installation
66
67 After following the official Galaxy setup and tool installation procedures:
68
69 1. Access your Galaxy instance (typically `http://localhost:8080`)
70 2. Check that COBRAxy tools appear in the tool panel
71 3. Verify Python dependencies are available in Galaxy's environment
72
73 ### Basic Usage
74
75 1. **Upload data** using Galaxy's data upload interface
76 2. **Select COBRAxy tools** from the tool panel
77 3. **Configure parameters** through the web interface
78 4. **Execute analyses** and monitor job progress
79 5. **Download results** from Galaxy's history panel
80
81 ## Creating COBRAxy Workflows
82
83 ### Workflow Development Resources
84
85 For creating workflows with COBRAxy tools in Galaxy:
86
87 - **[Galaxy Workflow Tutorial](https://training.galaxyproject.org/training-material/topics/galaxy-interface/tutorials/workflow-editor/tutorial.html)**
88 - Creating, editing, and sharing workflows
89 - Workflow best practices
90
91 - **[Workflow Management](https://docs.galaxyproject.org/en/master/user/galaxy_workflow.html)**
92 - Official workflow documentation
93 - Advanced workflow features
94
95 ### Example COBRAxy Workflow
96
97 A typical COBRAxy workflow might include:
98
99 1. **RAS Generator** → Generate activity scores from gene expression
100 2. **MAREA** → Perform statistical analysis and create pathway maps
101 3. **RAS to Bounds** → Apply constraints (optional, for flux analysis)
102 4. **Flux Simulation** → Sample metabolic fluxes (optional)
103 5. **Flux to Map** → Create final visualizations (optional)
104
105 ## Additional Resources
106
107 ### Galaxy Administration Resources
108
109 - **[Galaxy Admin Documentation](https://docs.galaxyproject.org/en/master/admin/)**
110 - Complete administrator guide
111 - Configuration, security, and maintenance
112
113 - **[Galaxy Training Materials](https://training.galaxyproject.org/)**
114 - Hands-on tutorials for administrators and users
115 - Best practices and troubleshooting
116
117 - **[Galaxy Community Hub](https://galaxyproject.org/)**
118 - Community support and resources
119 - Tool repositories and shared workflows
120
121 ### COBRAxy-Specific Resources
122
123 - **Dependencies**: Ensure `cobra`, `pandas`, `numpy`, `scipy` are installed in Galaxy's Python environment
124 - **Tool Files**: All COBRAxy XML and Python files should be accessible to Galaxy
125 - **Configuration**: Follow Galaxy's tool installation procedures for proper integration
126
127 ## Troubleshooting
128
129 For troubleshooting Galaxy installations and tool integration issues:
130
131 ### Official Troubleshooting Resources
132
133 - **[Galaxy FAQ](https://docs.galaxyproject.org/en/master/admin/faq.html)**
134 - Common installation and configuration issues
135 - Performance optimization tips
136
137 - **[Galaxy Help Forum](https://help.galaxyproject.org/)**
138 - Community-driven support
139 - Search existing solutions or ask new questions
140
141 - **[Galaxy GitHub Issues](https://github.com/galaxyproject/galaxy/issues)**
142 - Report bugs and technical issues
143 - Feature requests and discussions
144
145 ### COBRAxy-Specific Issues
146
147 For issues specific to COBRAxy tools in Galaxy:
148
149 - **Tool not appearing**: Check tool_conf.xml configuration and restart Galaxy
150 - **Execution failures**: Verify Python dependencies and file permissions
151 - **Parameter errors**: Ensure input data formats match tool requirements
152
153 Refer to the [COBRAxy Tools Documentation](../tools/) for detailed parameter information and data format requirements.
154
155 ## Summary
156
157 This tutorial provides guidance for setting up Galaxy with COBRAxy tools by referencing official Galaxy documentation. For detailed installation procedures, always consult the official Galaxy administrator guides, as they are regularly updated with the latest best practices and troubleshooting information.
158
159 The combination of Galaxy's web interface with COBRAxy's metabolic analysis capabilities provides a powerful platform for researchers who prefer graphical interfaces over command-line tools.