PennLINC / xcpEngine

Official public repository for the XCP Engine. This tool is deprecated in favor of XCP-D and ASLPrep.
MIT License
66 stars 42 forks source link

Formalizing Custom Atlas Guidelines #485

Open benjaminsipes opened 2 years ago

benjaminsipes commented 2 years ago

Hello xcpEngine team,

Thank you very much for your work on this phenomenal resource to the network neuroscience community!

I've seen a couple issues on the topic of adding an additional atlas, and while I've tried to follow the basic steps outlined there, I haven't yet been able to get results using my custom atlas (I'm trying to implement Brainnetome). Furthermore, if I was able to successfully implement this atlas, I'd love to pull-request to contribute to this amazing resource.

Would it be possible to write a detailed (for relative beginners; from atlas.nii.gz file to xcpEngine output) step-by-step description for adding a custom atlas to xcpEngine? If there's any additional information necessary to ensure we can effectively pull-request it to xcpEngine's repo, please include that as well, and I hope it can help crowdsource this feature and reduce future effort by you great developers! I think the xcpEngine documentation would be a great place to add these instructions.

Thank you very much for your help! I hope I can soon contribute a new atlas to xcpEngine!