Skip to content

Commit

Permalink
Add demo entrypoint
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt committed Oct 17, 2024
1 parent e49bf62 commit 8c91c29
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 2 deletions.
11 changes: 9 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,18 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
]
requires-python = ">=3.8"
requires-python = ">=3.8,<3.12"
dependencies = [
"anywidget>=0.2.3",
"cev-metrics>=0.1.2",
"ipywidgets>=8.0.0",
"jinja2>=3.0.0",
"jupyter-scatter>=0.14.0",
"pandas>=1.0",
"pandas>=1.0,<2.0",
"numpy>=1.0,<2.0",
"pyarrow",
"pooch>=1.3.0",
"rich>=13.0.0",
]
dynamic = ["version"]

Expand All @@ -45,6 +49,9 @@ notebooks = [
"matplotlib",
]

[project.scripts]
cev = "cev._cli:main"

[project.urls]
homepage = "https://github.com/OzetteTech/comparative-embedding-visualization"

Expand Down
118 changes: 118 additions & 0 deletions src/cev/_cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import argparse
import json
import os
import sys
import textwrap
import zipfile
from pathlib import Path

import pooch

from . import __version__


def download_data() -> tuple[Path, Path]:
archive = pooch.retrieve(
url="https://figshare.com/ndownloader/articles/23063615/versions/1",
path=pooch.os_cache("cev"),
fname="data.zip",
known_hash=None,
)
archive = Path(archive)
files = [
"mair-2022-tissue-138-umap.pq",
"mair-2022-tissue-138-ozette.pq",
]
with zipfile.ZipFile(archive, "r") as zip_ref:
for file in files:
zip_ref.extract(file, path=archive.parent)
return (
archive.parent / "mair-2022-tissue-138-umap.pq",
archive.parent / "mair-2022-tissue-138-ozette.pq",
)


def write_notebook(output: Path):
umap_path, ozette_path = download_data()
source = textwrap.dedent(f"""
import pandas as pd
from cev.widgets import Embedding, EmbeddingComparisonWidget
umap_embedding = pd.read_parquet("{umap_path}").pipe(Embedding.from_ozette)
ozette_embedding = pd.read_parquet("{ozette_path}").pipe(Embedding.from_ozette)
EmbeddingComparisonWidget(
umap_embedding,
ozette_embedding,
titles=("Standard UMAP", "Annotation-Transformed UMAP"),
metric="confusion",
selection="synced",
auto_zoom=True,
row_height=320,
)
""").strip()

nb = {
"cells": [
{
"cell_type": "code",
"execution_count": None,
"metadata": {},
"outputs": [],
"source": source,
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3",
}
},
"nbformat": 4,
"nbformat_minor": 5,
}
with output.open("w") as f:
json.dump(nb, f, indent=2)


def run_notebook(notebook_path: Path):
DEV = True
command = [
"uvx",
"--python",
"3.11",
"--with",
"." if DEV else f"cev=={__version__}",
"--with",
"jupyterlab",
"jupyter",
"lab",
str(notebook_path),
]
try:
os.execvp(command[0], command)
except OSError as e:
print(f"Error executing {command[0]}: {e}", file=sys.stderr)
sys.exit(1)


def main():
parser = argparse.ArgumentParser(prog="cev")
subparsers = parser.add_subparsers(dest="command", help="Available commands")
subparsers.add_parser("download", help="Download the demo notebook (and data)")
subparsers.add_parser("demo", help="Run the demo notebook in JupyterLab")
args = parser.parse_args()

notebook_path = Path("cev-demo.ipynb")
if args.command == "download":
write_notebook(notebook_path)
elif args.command == "demo":
write_notebook(notebook_path)
run_notebook(notebook_path)
else:
parser.print_help()


if __name__ == "__main__":
main()

0 comments on commit 8c91c29

Please sign in to comment.