Architecture 04 - Galaxy Files and Directory Structure

</span></div>

</span></div>

---

# Architecture 04 - Galaxy Files and Directory Structure

<div class="contributors-line">
		<a href="/training-material/hall-of-fame/jmchilton/" class="contributor-badge contributor-jmchilton"><img src="/training-material/assets/images/orcid.png" alt="orcid logo" width="36" height="36"/><img src="https://avatars.githubusercontent.com/jmchilton?s=36" alt="John Chilton avatar" width="36" class="avatar" />
    John Chilton</a>
	</div>

</div>

<div class="footnote" style="bottom: 8em;">
  <i class="far fa-calendar" aria-hidden="true"></i><span class="visually-hidden">last_modification</span> Updated:   
  
</div>

<div class="footnote" style="bottom: 5em;">

<i class="fas fa-file-alt" aria-hidden="true"></i><span class="visually-hidden">text-document</span><a href="slides-plain.html"> Plain-text slides</a> |

</div>

<div class="footnote" style="bottom: 2em;">
    <strong>Tip: </strong>press <kbd>P</kbd> to view the presenter notes
    | <i class="fa fa-arrows" aria-hidden="true"></i><span class="visually-hidden">arrow-keys</span> Use arrow keys to move between slides

</div>

???
Presenter notes contain extra information which might be useful if you intend to use these slides for teaching.

Press `P` again to switch presenter notes off

Press `C` to create a new window where the same presentation will be displayed.
This window is linked to the main window. Changing slides on one will cause the
slide to change on the other.

Useful when presenting.

---

### <i class="far fa-question-circle" aria-hidden="true"></i><span class="visually-hidden">question</span> Questions

- How is the Galaxy codebase organized?

- Where do I find different components?

- What is the difference between `lib` and `packages`?

---

### <i class="fas fa-bullseye" aria-hidden="true"></i><span class="visually-hidden">objectives</span> Objectives

- Navigate the Galaxy repository structure

- Understand the `lib` vs `packages` organization

- Locate key files and directories

---

# Architecture 04 - Galaxy Files and Directory Structure

*The physical architecture of the Galaxy code.*

---

layout: true
name: left-aligned
class: left, middle
---
layout: true
class: center, middle

---

### Project Docs

![Project Files](../../images/core_files_project_docs.mindmap.plantuml.svg)

---

### Code

![Code](../../images/core_files_code.mindmap.plantuml.svg)

---

### Scripts

![Scripts](../../images/core_files_scripts.mindmap.plantuml.svg)

---

### Test Sources

![Test Source Files](../../images/core_files_test.mindmap.plantuml.svg)

---

### Continuous Integration

![Continuous Integration Files](../../images/core_files_ci.mindmap.plantuml.svg)

---

### One Repository, Two Views of a Project

![Two Views of Galaxy Python Project](../../images/core_files_code_python_2_views.mindmap.plantuml.svg)

`lib` contains a single monolithic view of the `galaxy` namespace.

Each sub-directory of `packages` contains a logical subset of this `galaxy` namespace. Directory symbolic links are used to ensure the same files are used.

???

TODO: a slide before this one describing Python modules and how they map to files
using galaxy.util, galaxy.model.mapping, and galaxy.web.framework.

---

### Package Structure

![package structure](../../images/core_packages.plantuml.svg)

---

### PyPI

![galaxy-tool-util on PyPI](../../images/core_tool_util_pypi.png)

---

![Package Files](../../images/core_files_code_package.mindmap.plantuml.svg)

.footnote[Previous: [Galaxy Architecture Principles](/training-material/topics/dev/tutorials/architecture-principles/slides.html) | Next: [Galaxy Web Frameworks](/training-material/topics/dev/tutorials/architecture-frameworks/slides.html)]

---
### <i class="fas fa-key" aria-hidden="true"></i><span class="visually-hidden">keypoints</span> Key points

- Project documentation in root (README, CONTRIBUTING, CODE_OF_CONDUCT)

- Code in `lib` (monolithic) and `packages` (modular)

- Tests in `test` and `lib/galaxy_test`

- CI configuration in `.github`

- Packages are published to PyPI

---

## Thank You!

This material is the result of a collaborative work. Thanks to the [Galaxy Training Network](https://training.galaxyproject.org) and all the contributors!

</div>

</div>

Tutorial Content is licensed under <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br/>