glotzerlab / glotzerlab/MatSpat
Feedback for HW2- BIOINF 576
@npkamath is already working on this.
Since Feb 17, 2026.
- Dominant language
- Jupyter Notebook
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Hey Ninad,
My feedback for the project stems from what we discussed in class Monday. I was impressed by the technical aspect of the project and I think you have made great progress toward developing it to fit your image analysis goals. You mention that a challenge you are faced with currently is that although the project works well for your needs, you wanted to work on making it more accessible for general audiences. Your SRS document has a lot of in-depth information, so I would recommend adapting that into your Readme file. Specifically, taking some of those technical elements and thinking about how best to pitch them to a broader audience, since you mentioned you wanted the tool to be used by biologists who may not have much computer knowledge. By working through the Readme, it should help clarify which steps of the coding are most important to explain in more detail or could be simplified to make the features easier to implement. It's also possible that you make a version of the module that can run a bit lighter with default configurations for beginner users, but then a user can elect to run a more technical module that allows for full customization. I have found that writing out the big picture can help illuminate some of the next steps in coding! Good luck.
Contributor guide
No contributing guide indexed for this repository
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.
Assessment
This issue has not been assessed yet.