Skip to content

Commit

Permalink
📝 Update cellxgene-lamin to new docs artifacts convention (#141)
Browse files Browse the repository at this point in the history
* Update cellxgene-lamin to new docs artifacts convention

* Update noxfile.py

* rm links to query-census

* upd docs zip filenames

---------

Co-authored-by: Koncopd <[email protected]>
  • Loading branch information
falexwolf and Koncopd committed Sep 11, 2024
1 parent a38a95f commit afe32a7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/includes/features-lamindb.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
**Manage data & metadata with a unified Python API (“lakehouse”).**

- Query & search across artifacts ({class}`~lamindb.Artifact`) & metadata records ({class}`~lamindb.core.Record`): {class}`~lamindb.core.Record.filter`, {class}`~lamindb.core.Record.search`
- Query large array stores: {class}`~lamindb.Artifact.open`[guide](/query-census)
- Query large array stores: {class}`~lamindb.Artifact.open`[guide](cellxgene)
- Cache artifacts on disk & load them into memory: {class}`~lamindb.Artifact.cache`, {class}`~lamindb.Artifact.load`
- Manage features & labels: {class}`~lamindb.Feature`, {class}`~lamindb.FeatureSet`, {class}`~lamindb.ULabel`
- Plug-in custom [schemas](/schemas) & manage schema migrations
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Sync tracked scripts in lamindb with git commits: [guide](track.ipynb#sync-scrip

## Array stores

- `tiledbsoma`: [inhouse guide](scrna-tiledbsoma) or [cellxgene](query-census)
- `tiledbsoma`: [inhouse guide](scrna-tiledbsoma) or [cellxgene](cellxgene)
- [DuckDB](rxrx)

## Visualization tools
Expand Down
16 changes: 7 additions & 9 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,24 +175,22 @@ def pull_artifacts(session):
Path("lamin-mlops/mnist.ipynb").rename("docs/mnist.ipynb")

# cellxgene-lamin
pull_from_s3_and_unpack("cellxgene_lamin_docs.zip")
for path in Path("cellxgene_lamin_docs/").glob("*"):
if path.name.endswith(
("cellxgene.ipynb", "census.ipynb", "cellxgene-curate.ipynb")
):
pull_from_s3_and_unpack("cellxgene-lamin.zip")
for path in Path("cellxgene-lamin/").glob("*"):
if path.name.endswith(("cellxgene.ipynb", "cellxgene-curate.ipynb")):
sync_path(path, Path("docs") / path.name)

# lamin-spatial
pull_from_s3_and_unpack("rxrx_lamin_docs.zip")
for path in Path("rxrx_lamin_docs/").glob("*"):
pull_from_s3_and_unpack("lamin-spatial.zip")
for path in Path("lamin-spatial/").glob("*"):
if path.name == "rxrx.ipynb":
sync_path(path, Path("docs") / path.name)
elif path.name == "vitessce.ipynb":
sync_path(path, Path("docs") / path.name)

# use-cases
pull_from_s3_and_unpack("lamin_usecases_docs.zip")
for path in Path("lamin_usecases_docs/").glob("*"):
pull_from_s3_and_unpack("lamin-usecases.zip")
for path in Path("lamin-usecases/").glob("*"):
if (
path.name == "index.md"
or path.name == "usecases.md"
Expand Down

0 comments on commit afe32a7

Please sign in to comment.