Skip to content

BrainGlobe : Update Atlas packaging scripts to Altas API v2 (Pranav Kapoor) #44

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

Merged
merged 9 commits into from
Apr 8, 2025

Conversation

pranav33317
Copy link
Contributor

@pranav33317 pranav33317 commented Apr 2, 2025

Before submitting a pull request (PR), please read the contributing guide.

Please fill out as much of this template as you can, but if you have any problems or questions, just leave a comment and we will help out :)

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
My proposal for GSOC 2025
What does this PR do?

References

Please reference any existing issues/PRs that relate to this PR.

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

If this PR breaks any existing functionality, please explain how and why.

Does this PR require an update to the documentation?

If any features have changed, or have been added. Please explain how the
documentation has been updated.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@adamltyson
Copy link
Member

Hi @pranav33317, could you remove the template boilerplate text from your application, it's quite hard to read as it is.

Copy link
Contributor Author

@pranav33317 pranav33317 left a comment

Choose a reason for hiding this comment

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

Have made the changes sir . Could you please provide more feedback ?
Thanks

@adamltyson
Copy link
Member

Hi @pranav33317, there is still some of the template boilerplate text remaining. There is also formatting (e.g. indents that create code blocks) that make it hard to read. Could you view the markdown in the GitHub web interface and make the necessary changes? Thanks!

Could you also restore the deleted template file, so that it isn't removed when this PR is merged?

pranav33317 and others added 2 commits April 4, 2025 22:22
I fixed the indentation and formatting of the .md file.
Copy link
Contributor Author

@pranav33317 pranav33317 left a comment

Choose a reason for hiding this comment

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

Is this fine now sir @adamltyson ?

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

Hi @pranav33317, I've left a few suggestions. Please note at this stage, we're not able to offer any further feedback. Good luck!

Copy link
Member

Choose a reason for hiding this comment

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

Could you remove all changes to this file? The template should stay as it is for everyone else.

Copy link
Member

Choose a reason for hiding this comment

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

Could you rename this file to adhere to the template?

- PR: [https://github.com/brainglobe/brainglobe-atlasapi/pull/546#pullrequestreview-2729541724](https://github.com/brainglobe/brainglobe-atlasapi/pull/546#pullrequestreview-2729541724)
I tried to disable parallel mesh creation in various files to simplify mesh creation while simultaneously working on [Issue #429](https://github.com/brainglobe/brainglobeatlasapi/issues/429).
- **Proposal discussion link:**
- [https://github.com/brainglobe/brainglobe-atlasapi/pull/554](https://github.com/brainglobe/brainglobe-atlasapi/pull/554)
Copy link
Member

Choose a reason for hiding this comment

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

This should be a link to the discussion about your proposed project, i.e. this PR.

## Project proposal

### Synopsis
As someone deeply fascinated by the intricate workings of the brain, I have always admired how neuroanatomical atlases empower researchers to navigate complex brain structures with ease. BrainGlobe’s Atlas API stands out as a robust tool that consolidates atlas‑registered data into a unified Python interface. There is now an exciting opportunity to further enhance this system by adopting the OpenMINDS SANDS standard—a community‑driven format that delivers more interoperable brain data. This upgrade will enable researchers to derive deeper, more accurate insights.
Copy link
Member

Choose a reason for hiding this comment

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

While this is nice, it isn't really a synopsis of your project proposal.

### Synopsis
As someone deeply fascinated by the intricate workings of the brain, I have always admired how neuroanatomical atlases empower researchers to navigate complex brain structures with ease. BrainGlobe’s Atlas API stands out as a robust tool that consolidates atlas‑registered data into a unified Python interface. There is now an exciting opportunity to further enhance this system by adopting the OpenMINDS SANDS standard—a community‑driven format that delivers more interoperable brain data. This upgrade will enable researchers to derive deeper, more accurate insights.

My project aims to enhance the utility of the BrainGlobe ecosystem by updating the atlas packaging scripts so they output data in the OpenMINDS SANDS format. This upgrade is critical for researchers who need consistent, comprehensive data to integrate findings across studies and species. By delivering a modular, well-documented solution complete with rigorous testing, I will enable both seasoned neuroscientists and new entrants in the field, making advanced neuroinformatics more accessible to all.
Copy link
Member

Choose a reason for hiding this comment

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

How exactly will this make advanced neuroinformatics more accessible?

- Develop comprehensive tests covering all new and modified features.
- Update the documentation to guide users on how to generate and utilize OpenMINDS SANDS‑compliant atlases.
2. **Stretch Goals (if time permits):**
- Extend support for additional species or imaging modalities.
Copy link
Member

Choose a reason for hiding this comment

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

Do you mean extend support for additional atlases? Imaging modalities isn't really relevant here.

- Integrate schema validation using tools like `jsonschema` to ensure full compliance with OpenMINDS SANDS.
- Create a conversion utility for existing atlas packages to the new standard.
3. **Time Commitment:**
I will be devoting 30–35 hours per week towards this GSoC project.
Copy link
Member

Choose a reason for hiding this comment

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

Can you clarify the time commitment (and project size). Here you say 30-35 hours per week, but the timetable implies it's 30 hours every 2 weeks.

|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
| 1–2 | **Community Bonding & Research:**<br>- Immerse myself in the BrainGlobe Atlas API, current packaging scripts, and OpenMINDS SANDS documentation.<br>- Engage with mentors to clarify requirements and set up a focused development environment. | 30 |
| 3–4 | **Design & Planning:**<br>- Map the existing atlas data to the OpenMINDS SANDS schema.<br>- Design a modular function (e.g., `wrapup_atlas_to_openminds`) and create clear wireframes for the conversion workflow. | 30 |
| 5–6 | **Core Development – Part 1:**<br>- Develop the new wrap‑up function in a separate module (e.g., `openminds_wrapup.py`).<br>- Adapt the Allen Human atlas packaging script to integrate this function and produce the new output. | 30 |
Copy link
Member

Choose a reason for hiding this comment

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

Just because the human atlas is a low priority atlas, I would change this to the Allen mouse atlas.

@pranav33317
Copy link
Contributor Author

pranav33317 commented Apr 8, 2025

Sir I have made the changes you described, sorry for the time irregularities, have fixed them.
Could you please merge my proposal ?
Sorry found some errors , will re - commit in a minute
Thanks a lot for your feedback

@adamltyson
Copy link
Member

Great. Could you revert your changes to the application template so I can approve and merge this PR? Thanks!

@pranav33317
Copy link
Contributor Author

Great. Could you revert your changes to the application template so I can approve and merge this PR? Thanks!

Yes sir ,please give me a minute , the renaming deleted my file and I have mistakenly committed the older file. Will re- commit ASAP.
Thanks

@pranav33317
Copy link
Contributor Author

Yes sir , I am done , have restored the application template to its original state and resolved the errors in my proposal.
Thanks again :)

@adamltyson
Copy link
Member

Hi @pranav33317, there is still an edit to the application template (which reverts another PR). Could you remove it from this PR?

@pranav33317
Copy link
Contributor Author

Sir have restored the application template to the main branch :
image

@adamltyson adamltyson merged commit f70285a into neuroinformatics-unit:main Apr 8, 2025
@pranav33317
Copy link
Contributor Author

Sir should I submit my proposal in the .md file format ? What format should I use for the proposal pdf, the application template one ?
Thanks

@adamltyson
Copy link
Member

I think all details will be on the GSoC website. Please follow their instructions.

@umaima84
Copy link

umaima84 commented Apr 8, 2025

Hi @adamltyson,
I'm Umaima, and I'm interested in contributing to the Atlas Packaging Script project for GSoC 2025. I’m currently working on my proposal and would really appreciate it if you could review it before submission. Could you please let me know the best way to share my draft with you?

Also, I couldn’t find a dedicated repository for this specific project. Could you guide me on which repository I should contribute to for this project?

Thanks in advance!

@adamltyson
Copy link
Member

Hi @umaima84, please ask all questions on the Neuroinformatics Unit Zulip, in the #GSoC channel, otherwise other people are notified if you comment on a PR. All information is in our contributor guidelines but we won't be able to provide any feedback at this late stage.

@umaima84
Copy link

umaima84 commented Apr 9, 2025 via email

@adamltyson
Copy link
Member

Unfortunately we cannot consider any applications not submitted through the GSoC system. Please also refrain from commenting on unrelated PRs. I will now lock this conversation.

@neuroinformatics-unit neuroinformatics-unit locked as off-topic and limited conversation to collaborators Apr 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants