System Requirements and Internet Connectivity
---
Before beginning the installation process, ensure your system meets the following requirements:
- **Storage Space:** A minimum of 70 GB of free disk space is required for installation and initial operations. It is recommended to have up to 150 GB of free space to accommodate future updates and data management needs.
- Better have 500gb (if yo need to look example data from lfs server )
- **Memory:** At least 16 GB of RAM is essential for smooth performance during installation and runtime.
- **Internet Connection:** A stable internet connection is necessary throughout the installation process and for initial task executions. This ensures timely downloads and updates.
- **3000, 80 Ports:** If, for some reason, ports are not open in Docker, you may need to open ports 80 and 3000 for Docker, or you might have to disable the firewall.
- In the Docker settings under Resources, set a minimum of **8 GB Memory** limit.
Allow windows
---
## Please note that the demo server includes large datasets, which may result in lengthy download times. The time required will depend on your network speed and stability, so if any step appears to stall, you may pause with `Control+C` and restart as needed to continue the download process.
Datasets with which you can work are embedded in the repository at the links belowIMC Tonsil
- [IMC_Tonsil.ome.tiff](demo_data/Datasets/IMC_Tonsil/IMC_Tonsil.ome.tiff)
IMC PDAC
- [IMC_PDAC_ROI1.ome.tiff](demo_data/Datasets/IMC_PDAC/IMC_PDAC_ROI1.ome.tiff)
- [IMC_PDAC_ROI2.ome.tiff](demo_data/Datasets/IMC_PDAC/IMC_PDAC_ROI2.ome.tiff)
- [IMC_PDAC_ROI3.ome.tiff](demo_data/Datasets/IMC_PDAC/IMC_PDAC_ROI3.ome.tiff)
- [IMC_PDAC_ROI4.ome.tiff](demo_data/Datasets/IMC_PDAC/IMC_PDAC_ROI4.ome.tiff)
MIBI TNBC
- [TA459_multipleCores2_Run-4_Point1.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point1.tiff)
- [TA459_multipleCores2_Run-4_Point10.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point10.tiff)
- [TA459_multipleCores2_Run-4_Point11.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point11.tiff)
- [TA459_multipleCores2_Run-4_Point12.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point12.tiff)
- [TA459_multipleCores2_Run-4_Point13.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point13.tiff)
- [TA459_multipleCores2_Run-4_Point14.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point14.tiff)
- [TA459_multipleCores2_Run-4_Point15.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point15.tiff)
- [TA459_multipleCores2_Run-4_Point16.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point16.tiff)
- [TA459_multipleCores2_Run-4_Point17.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point17.tiff)
- [TA459_multipleCores2_Run-4_Point18.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point18.tiff)
- [TA459_multipleCores2_Run-4_Point19.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point19.tiff)
- [TA459_multipleCores2_Run-4_Point2.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point2.tiff)
- [TA459_multipleCores2_Run-4_Point20.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point20.tiff)
- [TA459_multipleCores2_Run-4_Point21.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point21.tiff)
- [TA459_multipleCores2_Run-4_Point22.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point22.tiff)
- [TA459_multipleCores2_Run-4_Point23.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point23.tiff)
- [TA459_multipleCores2_Run-4_Point24.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point24.tiff)
- [TA459_multipleCores2_Run-4_Point25.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point25.tiff)
- [TA459_multipleCores2_Run-4_Point26.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point26.tiff)
- [TA459_multipleCores2_Run-4_Point27.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point27.tiff)
- [TA459_multipleCores2_Run-4_Point28.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point28.tiff)
- [TA459_multipleCores2_Run-4_Point29.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point29.tiff)
- [TA459_multipleCores2_Run-4_Point3.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point3.tiff)
- [TA459_multipleCores2_Run-4_Point30.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point30.tiff)
- [TA459_multipleCores2_Run-4_Point31.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point31.tiff)
- [TA459_multipleCores2_Run-4_Point32.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point32.tiff)
- [TA459_multipleCores2_Run-4_Point33.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point33.tiff)
- [TA459_multipleCores2_Run-4_Point34.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point34.tiff)
- [TA459_multipleCores2_Run-4_Point35.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point35.tiff)
- [TA459_multipleCores2_Run-4_Point36.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point36.tiff)
- [TA459_multipleCores2_Run-4_Point37.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point37.tiff)
- [TA459_multipleCores2_Run-4_Point38.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point38.tiff)
- [TA459_multipleCores2_Run-4_Point39.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point39.tiff)
- [TA459_multipleCores2_Run-4_Point4.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point4.tiff)
- [TA459_multipleCores2_Run-4_Point40.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point40.tiff)
- [TA459_multipleCores2_Run-4_Point41.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point41.tiff)
- [TA459_multipleCores2_Run-4_Point5.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point5.tiff)
- [TA459_multipleCores2_Run-4_Point6.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point6.tiff)
- [TA459_multipleCores2_Run-4_Point7.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point7.tiff)
- [TA459_multipleCores2_Run-4_Point8.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point8.tiff)
- [TA459_multipleCores2_Run-4_Point9.tiff](demo_data/Datasets/MIBI_TNBC/TA459_multipleCores2_Run-4_Point9.tiff)
- [MERFISH NSCLC.h5ad](demo_data/UPLOADS/161065100/merfish_lung.h5ad)
## SPEX Application Microservices and Architecture
### Core Repositories:
- **Full Application Package** (use submodules for easy cloning of all components):
[spex_bundle](https://github.com/Genentech/spex_bundle)
- **Backend**: [spex_backend](https://github.com/Genentech/spex_backend)
- **Frontend**: [spex_frontend](https://github.com/Genentech/spex_frontend)
- **Common Modules**: [spex_common](https://github.com/Genentech/spex_common)
### Microservices:
- **Image Downloader from Omero for Processing**: [spex_ms_omero_image_downloader](https://github.com/Genentech/spex_ms_omero_image_downloader)
- **Omero Session Management** (providing image information and API access): [spex_ms_omero_sessions](https://github.com/Genentech/spex_ms_omero_sessions)
- **Task Queue Manager**: [spex_ms_pipeline_manager](https://github.com/Genentech/spex_ms_pipeline_manager)
- **Script Execution and Environment Management**: [spex_ms_job_manager](https://github.com/Genentech/spex_ms_job_manager)
### Algorithms:
- **Data Clustering**: [spex_clustering](https://github.com/Genentech/spex_clustering)
- **Image Segmentation**: [spex_segmentation](https://github.com/Genentech/spex_segmentation)
- **Spatial Transcriptomics**: [spex_spatial_transcriptomics](https://github.com/Genentech/spex_spatial_transcriptomics)
These algorithms enable customization of data processing parameters and are integrated with the `spex_ms_job_manager` microservice for executing analytical tasks.
# Installation Guide
## Install Git LFS for Managing Large Files
Ubuntu
- Open Terminal and run:
```
sudo apt update
sudo apt install git-lfs
```
Windows
- Download and install [Git for Windows](https://git-scm.com/download/win).
- if you have installed Git for Windows, you can check if running installs Git LFS:
- Open Powershell as administrator and run:
```
git lfs install
```
if you have this output:
```
Git LFS initialized.
```
go to the next step [Bundle installation](#bundle-installation)
, if not
- Download and install [Git LFS](https://git-lfs.github.com/)
follow the instructions for Windows installation.
## Bundle Installation
- Go to the folder where you will deploy the project.
To navigate to a project folder in the terminal, you can use the cd command, which stands for "change directory."
```
cd my_project
```
- To set up Git LFS, open the terminal and run the following command:
```
git lfs install
```
- For the production bundle of the application, clone the repository:
```
git clone https://github.com/Genentech/spex_demo.git .
git lfs pull
```
- Wait for the process to complete. The total size of all downloaded project files should be around 10 gigabytes.
Set executable permissions (Ubuntu):
```
chmod -R +x .
```
## Install Docker desktop on your Local Machine
- Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop)
### Run application demo script:
Ubuntu
- Execute the application demo script:
```
./app_demo.sh up
```
Windows
- Run the PowerShell script by command as administrator:
```
PowerShell.exe -ExecutionPolicy Unrestricted -File .\app_demo.ps1 up
```
windows 11 time to up
Wait for the download to complete. If the download does not complete or hangs due to unstable connection, stop the process control+C and start the process again.
After the download is complete and the necessary images and containers are created, you should see 11 containers in the Docker application.
As a result, a browser window should open asking you to log in. If the page is not displayed? Try waiting 5-15 minutes and reload the page. Perhaps the containers have not all had time to collect yet.
**for open application you can start host "http://127.0.0.1:3000" in your browser,
at the first start, I would wait 5 minutes for the services to be initialized, such as the Omero server and frontend.**
for more information about SPEX can use
Working workflow
- login in application use username **root** and password **omero**
- ## create process
To initiate a test process, first select Project 1 and click the **Analyze** button.
Next, click the "Add Process" button, and enter the name of the process, such as "test".
Then, access the process by clicking on it in the process list, and proceed to create the first task.
- ## create tasks
Blocks can be connected to each other; the entry point is the choice of what we work with,
an image or an anndata file. Subsequently, we select the following related blocks,
which perform data transformation to achieve the desired result.
- ## run tasks
All tasks are executed sequentially. You can start all tasks using the "Start ▶" button or the "Play ▶"
button in each block. Also, you can delete a block if it is not needed.
- ## Fix errors
During the initial launch, related libraries are downloaded from the internet.
If the internet connection is unstable, the installation may fail, indicated by a red flag over the task name.
To reinitialize the installation or restart the task, you need to press the play button **▶** as shown below.
- ## View results
The results of the pipeline execution can be viewed in the review tab.
If for some reason they are not displayed, you can request the data to be regenerated by pressing the
"Delete zarr data" button and then the "Create zarr data" button.
