Code indexing in gitaly is broken and leads to code not being visible to the user. We work on the issue with highest priority.

Skip to content
Snippets Groups Projects
Commit df4bd2b3 authored by florez_j's avatar florez_j
Browse files

Add directory tree structure description.

parent 368e4ce6
No related branches found
No related tags found
No related merge requests found
......@@ -16,10 +16,6 @@ DIMA provides reusable operations for data integration, manipulation, and extrac
4. **Jupyter notebooks**
Demonstrates DIMA’s core functionalities, such as data integration, HDF5 file creation, visualization, and metadata annotation. Key notebooks include examples for data sharing, OpenBis ETL, and workflow demos.
## Repository Structure
## Requirements
For **Windows** users, the following are required:
......@@ -66,7 +62,29 @@ Open **Anaconda Prompt** or a terminal with access to conda.
conda env create --file environment.yml
```
## Software arquitecture
## Repository Structure and Software arquitecture
**Directories**
- `input_files/` stores some example raw input data or campaign descriptor YAML files.
- `output_files/` stores generated outputs for local processing.
- `instruments/` contains instrument-specific dictionaries and file readers.
- `src/` contains the main source code, HDF5 Writer and Data Operations Manager.
- `utils/` contains generic data conversion operations, supporting the source code.
- `notebooks/` contains a collection of Jupyter notebooks, demonstrating DIMA's main functionalities.
- `pipelines/` contains source code for the data integration pipeline and metadata revision workflow.
- `visualization/` contains primarily functions for visualization of HDF5 files as treemaps.
---
**Software arquitecture**
<p align="center">
<img src="docs/software_arquitecture_diagram.svg" alt="Alt Text">
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment