Development of the SLAM -Surface anaLysis And Modeling- python package
Project info
Title: Development of the SLAM -Surface anaLysis And Modeling- python package
Project lead: Guillaume Auzias will be the main project manager and will be helped by Alexandre Pron during this brainhack.
Project collaborators: Main developers are the members of the MeCA team (http://meca-brain.org/), but we are welcoming warmly external collaborators, contributors and users.
Registered Brainhack Global 2020 Event: Brainhack Marseille
Project Description: Slam (https://gauzias.github.io/slam/) is an open source python package dedicated to the representation of neuroanatomical surfaces stemming from MRI data in the form of triangular meshes and to their processing and analysis.
Main features include read/write gifti (and nifti) file format, geodesic distance computation, several implementations of graph Laplacian and Gradient, mesh surgery (boundary identification, large hole closing), several types of mapping between the mesh and a sphere, a disc… Have a look at the examples on the documentation website: https://gauzias.github.io/slam/auto_examples/index.html
Data to use:
Link to project repository/sources: https://github.com/gauzias
Goals for Brainhack Global 2020: During this brainhack, our objectives are:
to add as a new feature the algorithms for computing surface profiling as described in Li, K., Guo, L., Li, G., Nie, J., Faraco, C., Cui, G., Zhao, Q., Miller, L.S. and Liu, T., 2010. Gyral folding pattern analysis via surface profiling. NeuroImage, 52(4), pp.1202-1214. https://doi.org/10.1016/j.neuroimage.2010.04.263
to improve the documentation with new examples to enrich the gallery (https://gauzias.github.io/slam/auto_examples/index.html), which helps a lot potential new users
to further improve code quality with new unitest and potential speed-up of specific pieces of code such as for instance the computation of the curvature
to help potential users to get familiar with this python package
we are of course also open if new features are proposed from the contributors
Good first issues:
- Share ideas, remarks, bugs using Github issues (https://github.com/gauzias/slam/issues)
- Check generic guidelines and installation instructions (https://github.com/gauzias/slam/blob/master/README.md)
Skills: python 50%, mesh processing 20%, will to share ideas and good time 100% Minimal skills in python coding and github are required, but various levels of expertise are welcome since some of our objectives can be addressed with limited coding effort such as augmenting the documentation.
Tools/Software/Methods to Use:
Communication channels:
Video channel:
- I added all of the labels I want an associate to my project
Project Submission
Submission checklist
Once the issue is submitted, please check items in this list as you add under ‘Additional project info’
- Link to your project: could be a code repository, a shared document, etc.
- Goals for Brainhack Global 2020: describe what you want to achieve during this brainhack.
- Flesh out at least 2 “good first issues”: those are tasks that do not require any prior knowledge about your project, could be defined as issues in a GitHub repository, or in a shared document.
- Skills: list skills that would be particularly suitable for your project. We ask you to include at least one non-coding skill. Use the issue labels for this purpose.
Optionally, you can also include information about:
- Number of participants required.
- Twitter-sized summary of your project pitch.
- Provide an image of your project for the Brainhack Global 2020 website.
We would like to think about how you will credit and onboard new members to your project. If you’d like to share your thoughts with future project participants, you can include information about:
- Specify how you will acknowledge contributions (e.g. listing members on a contributing page).
- Provide links to onboarding documents if you have some: