Scilo¶
Keep your scientific research repositories organized.
scilo scans a project directory to look for specific directories, like code/ and data/ to check that they meet desired criteria.
Setting and following expectations ensures consistency in teams of any size and enables projects that are understandable by people, not just machines.
How does scilo work?¶
scilo borrows a concept from software development called "linting".
It statically scans files and folders in the directory where you've placed your scientific code and checks them against a series of lints.
If all the lints pass, scilo returns successfully.
If not, scilo will fail and return information about the failed check.
These lints are customizable with a configuration file.
See Concepts for details about how scilo works.
Quickstart¶
After installing scilo, navigate to your project directory in a terminal and run:
For help with the command line interface, run:
You can configure scilo to work according to your needs.
See Configuration for details.
If you want to integrate scilo into your workflow with other tools, see Integration with other tools.
Where does the name come from?¶
Scilo is pronounced like the English word "silo" ([sahy-loh] / ˈsaɪ loʊ /).
Data, code, and results belong in separate bins, so scilo helps keeps them organized and siloed.