New easier intro notebooks
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 394
- Forks
- 95
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 7
Description
We have received feedback that our intro notebooks "Use SpatialData with your data":
- I. Use SpatialData with your data: the SpatialData object
- II. Use SpatialData with your data: SpatialElements and tables
are too tech heavy.
We should consider moving them to a section of notebooks targeting methods developers and make a slimmer version of them (maybe a single intro notebook?) using a biological dataset.
Any of the 5 datasets described here: https://github.com/scverse/spatialdata/issues/700#issuecomment-2326790050 could be used.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing models1.html and models2.html notebooks and the five dataset options described in issue #700. Decide how the notebooks should be split or simplified for biological data, then confirm that the resulting intro material is less technical and the methods-developer material is separated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100