Skip to main content

🎨 A toolkit to explore the Aignostics OpenTME dataset.

Project description

License CI Dependabot Renovate enabled codecov Ruff Copier Open in molab

🎨 TME Studio

Welcome to TME Studio! This readme explains the content of TME Studio, and the dataset it is built on: OpenTME.

New to TME Studio? Want to try out the notebooks right away without any set up required? Try out our interactive demo via molab. Make sure you have access to OpenTME on Hugging Face, then open the link and start exploring.

Already familiar with TME Studio? You want to edit the notebooks and adapt them to your needs? You can choose to either

Content

What is OpenTME?

OpenTME is an open-source project by Aignostics that provides academic researchers with pre-computed quantitative TME (Tumor Micro-Environment) features across H&E-stained Whole-Slide Images (WSIs) from The Cancer Genome Atlas (TCGA). It provides comprehensive spatial outputs characterizing key cellular and tissue components of the TME, including cancer cells, immune cells, and stromal features, as well as their relationships within the tissue architecture.

All outputs were generated using Atlas H&E-TME, Aignostics' AI-powered computational pathology application for the automated identification and quantification of TME features in FFPE H&E-stained tissue samples.

What is TME Studio?

TME Studio contains a set of tutorials and example notebooks to help you explore OpenTME. TME Studio is provided as an entry point into OpenTME, and intended to accelerate research output from the OpenTME data.

Content

The structure of the notebooks in this repo looks as follows:

tme_studio/
|-- src/
    |-- aignostics_tme_studio/
        |-- notebooks/
            |-- demo/
            |-- examples/
            |-- tutorials/

Each folder is described below. Follow the links and click the "Fork" button to run the notebooks in molab (make sure you have access to OpenTME on Hugging Face, and a molab account).

If you are unfamiliar with the OpenTME dataset, we suggest beginning at the getting started notebook. To get a feeling for all the different features you can find in OpenTME, have a look at the demo.

Setup instructions

Hugging Face access

Regardless of how you decide to run the notebooks, you will need to get access to OpenTME on Hugging Face 🤗.

Creating an access token

  1. Make sure you have a Hugging Face account. If you don't have one, you can create one for free at hf.co/join.
  2. Get access to the dataset by going to https://huggingface.co/datasets/Aignostics/OpenTME and clicking "Access"

Note: You will receive an email from Hugging Face as soon as your access request has been reviewed. This may take a few working days.

Note: No need to download the dataset! The tutorials will show you how to access the dataset via the Hugging Face API.

  1. Create an access token by going to https://huggingface.co/settings/tokens

Authenticating with your token

You can now use your token in two ways:

  1. Enter it in the designated box for it inside each notebook. This is how you authenticate when you are running a notebook in molab. You will have to repeat this action each time you open a notebook.

  2. Log in via the Hugging Face CLI (only when running notebooks locally). In this case your token will be stored and you won't have to enter your token each time you open a notebook.

    1. Download the Hugging Face CLI
    2. Log into hugging face by calling
hf auth login

and log in with your access token.

Note: If you invalidated your token, you can force logging in with a new token by calling hf auth login \--force

Edit notebooks in molab

To edit your own copy of the TME Studio notebooks in molab, do the following:

  1. Open the notebook of choice via the link in the content overview above. E.g. our Demo notebook.
  2. Create a molab account, via the "Sign In" button in the upper right corner.
  3. Click the "Fork" button.
  4. Run the notebook via the play button.
  5. Install "missing packages" via the pop-up menu on the left tab bar.

You can start exploring now.

Edit notebooks locally

To run the TME Studio notebooks on your local machine, follow these installation instructions:

Prerequisites

Tool Version Purpose
mise latest Task runner & tool version manager
Git latest Version control

Installing mise

mise manages tool versions (Python, uv, trivy, etc.) and runs all project tasks. Install it first:

curl https://mise.run | sh

# activate mise in the current shell and add to shell config for future sessions
echo 'eval "$(mise activate --shims bash)"' >> ~/.bashrc
source ~/.bashrc

For .zsh users:

echo 'eval "$(mise activate --shims zsh)"' >> ~/.zshrc
source ~/.zshrc

For other shells, see mise installation docs.

Verify the installation:

mise --version

# Check path - mise shims should be first in the PATH to ensure the correct tool versions are used
echo $PATH

which uv # Path should contain the `mise/shims/uv` shim, not a system-wide uv installation; please do not install uv in the same directory as `mise` to avoid conflicts

Cloning the repository

Authenticate with GitHub using the Github CLI to clone the repository:

gh auth login

gh repo clone aignostics/tme-studio

cd tme-studio
mise trust
gh auth setup-git

Installation

# Install all dev dependencies, pre-commit hooks, and keyring tooling
mise run install

# Verify everything works
mise run lint

# List all existing mise tasks
mise tasks

This runs uv sync --all-extras to install all dependencies, then sets up pre-commit hooks.

Starting Marimo

You are now ready to explore the notebooks! 🎨

Start marimo by calling the following command and opening the URL in your browser:

uv run marimo edit

Use the marimo UI opened in your browser to navigate to the notebooks.

Alternatively, you can run

uv run marimo edit path/to/notebook.py

to open a specific notebook directly.

Citation

If you use OpenTME or TME Studio in your research, please cite:

@article{galama2026opentme,
  title={{OpenTME}: An Open Dataset of {AI}-Powered {H\&E} Tumor 
         Microenvironment Profiles from {TCGA}},
  author={Galama, Maaike and Kozar-Gillan, Nina and Embacher, Christina 
          and Dembo, Todd and B{\"o}hm, Cornelius and Ramberger, Evelyn 
          and Ribbat-Idel, Julika and Krupar, Rosemarie and Aumiller, Verena 
          and H{\"a}gele, Miriam and Standvoss, Kai and Erdmann, Gerrit 
          and Pablos, Blanca and Angelo, Ari and Schallenberg, Simon 
          and Norgan, Andrew and Matyas, Viktor and M{\"u}ller, Klaus-Robert 
          and Alber, Maximilian and Ruff, Lukas and Klauschen, Frederick},
  journal={arXiv preprint arXiv:2604.12075},
  year={2026},
  url={https://arxiv.org/abs/2604.12075},
}

Further reading

  • OpenTME - Paper on arxiv describing OpenTME and TME Studio
  • Security policy - Documentation of security checks, tools, and principles
  • Release notes - Complete log of improvements and changes
  • Attributions - Open source projects this project builds upon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aignostics_tme_studio-0.3.0.tar.gz (6.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aignostics_tme_studio-0.3.0-py3-none-any.whl (6.3 MB view details)

Uploaded Python 3

File details

Details for the file aignostics_tme_studio-0.3.0.tar.gz.

File metadata

  • Download URL: aignostics_tme_studio-0.3.0.tar.gz
  • Upload date:
  • Size: 6.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for aignostics_tme_studio-0.3.0.tar.gz
Algorithm Hash digest
SHA256 bf54747c624288eeea493caec15dddbaa7268f327b21e456390f1549113ee199
MD5 71275570da4348d5cda2517989b182e5
BLAKE2b-256 bc2d636a3d63946e99cc4556b3ce1e54541eb3e3907af1310baeeb2cd3ce3b20

See more details on using hashes here.

File details

Details for the file aignostics_tme_studio-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: aignostics_tme_studio-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for aignostics_tme_studio-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee95d8fc5bb72d122248e9c82b878a2b0c863d8355f64d56b5a3084aec6890f3
MD5 a17f19797e037d6ecec51ab96e90655d
BLAKE2b-256 03f8e2fbbc5dc548ae45f64c7c45fbaf76f43514975c45b15781362565685c03

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page