-
-
Notifications
You must be signed in to change notification settings - Fork 118
Home
Joshua Newton edited this page Jun 2, 2025
·
119 revisions
This knowledge base contains internal developer documentation for SCT developers.
If this is your first time visiting this wiki, here are some important pages that will help get you started:
- Project overview: Start with this page, which will provide you with some background context on what SCT is and how it's used, as well as give you a bird's eye view of how SCT's codebase is structured.
- "good first issues": These are small tasks that will can help new contributors get familiar with SCT's typical workflow (opening a branch, submitting a pull request, receiving a PR review, and responding to feedback).
- NeuroPoly Contributing Guidelines: If you're new to contributing on GitHub, this page will provide you with some basic guidance, including how to work on branches and submit pull requests.
-
Installing SCT for development: After you've found an issue you'd like to work on, you can follow this page to prepare your working environment for development on SCT.
- Note: This is only truly necessary if you plan to make intensive changes to SCT that you wish to test out locally.
Editing the Wiki? If you're adding a new page or changing a title, be sure it fits the existing Wiki Structure.

- Contributing
-
Programming
- API code vs CLI code
- Argparse usage in CLI scripts
- CLI script structure
- Commenting
- Exceptions
- General guidelines
- Logging
- Moving away from pyplot
- Moving away from sct.run and run_proc
- Naming conventions (variables, files)
- QC Reports
- Shell scripts
- Single or double quotes
- Time Profiling and Memory Tracing
- Useful file tools in Python
- Documentation
- Testing
- Packaging
- Websites
- DL models