Download
The SciML Style Guide is a style guide for the Julia programming language. It is used by the SciML Open Source Scientific Machine Learning Organization. As such, it is open to discussion with the community. If the standard for code contributions is that every PR needs to support every possible input type that anyone can think of, the barrier would be too high for newcomers. Instead, the principle is to be as correct as possible to begin with, and grow the generic support over time. All recommended functionality should be tested, and any known generality issues should be documented in an issue (and with a @test_broken test when possible). However, a function that is known to not be GPU-compatible is not grounds to block merging, rather it is encouraged for a follow-up PR to improve the general type support.
Features
- Subpackaging and interface packages is preferred over conditional modules via Requires.jl
- Numerical functionality should use the appropriate generic numerical interfaces
- Functions should capture one underlying principle
- Generic code is preferred unless code is known to be specific
- Documentation available
- Examples available
Project Samples
