Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Census Visium Builder Prototype #1165

Draft
wants to merge 29 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
56bd44b
Add setup instructions to integrate soma spatial
prathapsridharan May 28, 2024
76c2a8a
Install `git` in census builder docker container
prathapsridharan May 28, 2024
a38c215
Add back pyarrow pin on builder for testing
prathapsridharan May 28, 2024
8ae84af
Modify builder pins to test builder unit tests on GH
prathapsridharan May 28, 2024
b330183
Remove cellxgene_census package dependency for testing
prathapsridharan May 29, 2024
6655196
Pin to tiledbsoma commit to test builder unit tests
prathapsridharan May 29, 2024
e91b2fa
Pin to tiledbsoma git commit for 1.9.5 to test
prathapsridharan May 29, 2024
4115601
Unpin pyarrow in builder to test builder unit tests
prathapsridharan May 29, 2024
1c7f985
Pin to tiledbsoma git commit for 1.10.2 to test
prathapsridharan May 29, 2024
4aa689e
Pin to tiledbsoma git commit for 1.11.1 to test
prathapsridharan May 29, 2024
327cee6
Pin tiledbsoma to 16f481f - head of spatial branch
prathapsridharan May 30, 2024
97ef790
Pin pyarrow back to 15.0.2
prathapsridharan May 30, 2024
3567dc7
Pin tiledbsoma to fc5f8e7 to fix census builder tests
prathapsridharan Jun 3, 2024
ba5ac8f
Add comments to notebook
prathapsridharan Jun 4, 2024
b448027
Create notebook to demo census object creation
prathapsridharan Jun 4, 2024
0f1f20a
Use absolute file path for contents of manifest file
prathapsridharan Jun 5, 2024
5c81aaa
Add "EFO:0010961" to the list of allowed assays
prathapsridharan Jun 5, 2024
ce4b525
Add comments for clarity in pyproject.toml
prathapsridharan Jun 5, 2024
1f654b6
Fix filepaths in notebook
prathapsridharan Jun 5, 2024
4712e95
Make census builder run without errors on spatial datasets
prathapsridharan Jun 5, 2024
e7e6b07
Add census_data and census_spatial collections
prathapsridharan Jun 7, 2024
44c1109
Update notebook
prathapsridharan Jun 7, 2024
1854f41
Pin tiledbsoma to commit 5069714 for latest spatial
prathapsridharan Jun 12, 2024
14d682e
Update tiledbsoma spatial notebook
prathapsridharan Jun 12, 2024
bf0fdea
Update tiledbsoma spatial notebook
prathapsridharan Jun 12, 2024
ebbe1b1
Update tiledbsoma spatial notebook
prathapsridharan Jun 12, 2024
ff73498
Pin tiledbsoma to commit 69d699e for latest spatial
prathapsridharan Jun 12, 2024
a5c21a1
Pin tiledbsoma to commit 9eb540f for latest spatial
prathapsridharan Jun 13, 2024
2cef2bb
Update tiledbsoma spatial notebook
prathapsridharan Jun 14, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion api/python/cellxgene_census/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ dependencies= [
# NOTE: the tiledbsoma version must be >= to the version used in the Census builder, to
# ensure that the assets are readable (tiledbsoma supports backward compatible reading).
# Make sure this version does not fall behind the builder's tiledbsoma version.
"tiledbsoma~=1.11.4",
# TODO (spatial): tiledbsoma pin to a PyPI release is temporarily commented out in favor git commit pin
# "tiledbsoma==1.11.4",
# TODO (spatial): Pin tiledbsoma dependency to an actual released version after tiledbsoma spatial code has been released
"tiledbsoma @ git+https://github.com/single-cell-data/TileDB-SOMA.git@9eb540f#egg=tiledbsoma&subdirectory=apis/python/",
"anndata",
"numpy>=1.21,<2.0",
"requests",
Expand Down
2 changes: 2 additions & 0 deletions tools/cellxgene_census_builder/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ ARG COMMIT_SHA
ENV COMMIT_SHA=${COMMIT_SHA}

# Ubuntu 22 contains only the python3.11 RC as of 2023-12-21, so use deadsnakes
# TODO (spatial): `git` is added to this dockerfile to be able to install python packages from github. Remove when it is not needed.
RUN apt update && \
apt install -y software-properties-common && \
add-apt-repository -y ppa:deadsnakes/ppa && \
apt update && \
apt -y full-upgrade && \
apt -y install python3.11 python3.11-venv python3-pip awscli && \
apt -y install git && \
apt-get clean

# set python3.11 as default
Expand Down
9 changes: 9 additions & 0 deletions tools/cellxgene_census_builder/SPATIAL-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Development Environment Setup and Run

- `pip install -e tools/cellxgene_census_builder`

**NOTE:** When running the builder on MacOS, unpin `pyarrow` in [census builder pyproject.toml](./pyproject.toml)

- `pip install -e api/python/cellxgene_census`

- [Dev tools for spatial](./spatial_dev_tools/) contains scripts and notebooks to aid development and testing
8 changes: 6 additions & 2 deletions tools/cellxgene_census_builder/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,12 @@ dependencies= [
# recent cellxgene-census _readers_ are able to read the results of a Census build (writer).
# The compatibility matrix is defined here:
# https://github.com/TileDB-Inc/TileDB/blob/dev/format_spec/FORMAT_SPEC.md
"tiledbsoma==1.9.3",
"cellxgene-census==1.12.0",
# TODO (spatial): tiledbsoma pin to a PyPI release is temporarily commented out in favor git commit pin
# "tiledbsoma==1.9.3",
# TODO (spatial): Pin tiledbsoma dependency to an actual released version after tiledbsoma spatial code has been released
"tiledbsoma @ git+https://github.com/single-cell-data/TileDB-SOMA.git@9eb540f#egg=tiledbsoma&subdirectory=apis/python/",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"tiledbsoma @ git+https://github.com/single-cell-data/TileDB-SOMA.git@9eb540f#egg=tiledbsoma&subdirectory=apis/python/",
"tiledbsoma @ git+https://github.com/single-cell-data/TileDB-SOMA.git@spatial#egg=tiledbsoma&subdirectory=apis/python/",

Is there a reason you pin to this specific commit rather point at the spatial branch?

I believe the branch is being rebased, so specific commits get deleted.

# TODO (spatial): Uncomment line below to install "cellxgene-census" at an appropriate version when tiledbsoma spatial code has been released
# "cellxgene-census==1.12.0",
"cellxgene-ontology-guide==0.6.1",
"scipy==1.12.0",
"fsspec[http]==2024.3.1",
Expand Down
Empty file.

Large diffs are not rendered by default.

Loading
Loading