SimpleWorkflowRecipes
Documentation for SimpleWorkflowRecipes.
See the Index for the complete list of documented functions and types.
The code is hosted on GitHub, with some continuous integration services to test its validity.
This repository is created and maintained by @singularitti. You are very welcome to contribute.
Installation
The package can be installed with the Julia package manager. From the Julia REPL, type ]
to enter the Pkg REPL mode and run:
pkg> add SimpleWorkflowRecipes
Or, equivalently, via the Pkg
API:
julia> import Pkg; Pkg.add("SimpleWorkflowRecipes")
Resolving package versions... Installed SimpleWorkflowRecipes ─ v0.2.0 Updating `~/work/SimpleWorkflowRecipes.jl/SimpleWorkflowRecipes.jl/docs/build/developers/Project.toml` [8a651d91] + SimpleWorkflowRecipes v0.2.0 Updating `~/work/SimpleWorkflowRecipes.jl/SimpleWorkflowRecipes.jl/docs/build/developers/Manifest.toml` [ec485272] + ArnoldiMethod v0.2.0 [6e4b80f9] + BenchmarkTools v1.3.2 ⌅ [fa961155] + CEnum v0.4.2 [523fee87] + CodecBzip2 v0.8.1 [944b1d66] + CodecZlib v0.7.3 [bbf7d656] + CommonSubexpressions v0.3.0 [163ba53b] + DiffResults v1.1.0 [b552c78f] + DiffRules v1.15.1 [ffbed154] + DocStringExtensions v0.9.3 [e2685f51] + ECOS v1.1.1 [db8ca866] + EasyJobsBase v0.15.0 [f6369f11] + ForwardDiff v0.10.36 [86223c79] + Graphs v1.9.0 [87dc4568] + HiGHS v1.7.5 [d25df0c9] + Inflate v0.1.4 [92d709cd] + IrrationalConstants v0.2.2 [c8e1da08] + IterTools v1.8.0 [692b3bcd] + JLLWrappers v1.5.0 [4076af6c] + JuMP v1.16.0 [f4a74d36] + LayeredLayouts v0.2.9 [2ab3a3ac] + LogExpFunctions v0.3.26 [1914dd2f] + MacroTools v0.5.11 [b8f27783] + MathOptInterface v1.21.0 [d8a4904e] + MutableArithmetics v1.3.3 [77ba4419] + NaNMath v1.0.2 [3cdcf5f2] + RecipesBase v1.3.4 [699a6c99] + SimpleTraits v0.9.4 [8a651d91] + SimpleWorkflowRecipes v0.2.0 [6a97d125] + SimpleWorkflows v0.29.0 [66db9d55] + SnoopPrecompile v1.0.3 [276daf66] + SpecialFunctions v2.3.1 [90137ffa] + StaticArrays v1.6.5 [1e83bf80] + StaticArraysCore v1.4.2 [6d80a3f9] + Thinkers v0.4.1 [3bb67fe8] + TranscodingStreams v0.10.1 [6e34b625] + Bzip2_jll v1.0.8+0 [c2c64177] + ECOS_jll v200.0.800+0 [8fd58aa0] + HiGHS_jll v1.6.0+0 [efe28fd5] + OpenSpecFun_jll v0.5.5+0 [8ba89e20] + Distributed [37e2e46d] + LinearAlgebra [9abbd945] + Profile [1a1011a3] + SharedArrays [2f01184e] + SparseArrays [10745b16] + Statistics v1.9.0 [8dfed614] + Test [e66e0078] + CompilerSupportLibraries_jll v1.0.5+0 [4536629a] + OpenBLAS_jll v0.3.21+4 [05823500] + OpenLibm_jll v0.8.1+0 [bea87d4a] + SuiteSparse_jll v5.10.1+6 [8e850b90] + libblastrampoline_jll v5.8.0+0 Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m` Precompiling project... ✓ SimpleWorkflowRecipes 1 dependency successfully precompiled in 8 seconds. 63 already precompiled. 1 dependency precompiled but a different version is currently loaded. Restart julia to access the new version
Documentation
- STABLE — documentation of the most recently tagged version.
- DEV — documentation of the in-development version.
Project status
The package is tested against, and being developed for, Julia 1.6
and above on Linux, macOS, and Windows.
Questions and contributions
Usage questions can be posted on our discussion page.
Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The Contributing page has a few guidelines that should be followed when opening pull requests and contributing code.
Manual outline
- Installation Guide
- Contributing
- Code of conduct
- Join the community forum
- Improve the documentation
- File a bug report
- Contribute code to SimpleWorkflowRecipes
- Step 1: decide what to work on
- Step 2: fork SimpleWorkflowRecipes
- Step 3: install SimpleWorkflowRecipes locally
- Step 4: checkout a new branch
- Step 5: make changes
- Step 6a: test your code changes
- Step 6b: test your documentation changes
- Step 7: make a pull request
- Step 8: respond to comments
- Step 9: cleaning up
- Style Guide
- Design Principles
- Consistency vs adherence
- Community contribution guidelines
- Open source contributions are allowed to start small and grow over time
- Generic code is preferred unless code is known to be specific
- Internal types should match the types used by users when possible
- Trait definition and adherence to generic interface is preferred when possible
- Macros should be limited and only be used for syntactic sugar
- Errors should be caught as high as possible, and error messages should be contextualized for newcomers
- Subpackaging and interface packages is preferred over conditional modules via Requires.jl
- Functions should either attempt to be non-allocating and reuse caches, or treat inputs as immutable
- Out-Of-Place and Immutability is preferred when sufficient performant
- Tests should attempt to cover a wide gamut of input types
- When in doubt, a submodule should become a subpackage or separate package
- Globals should be avoided whenever possible
- Type-stable and Type-grounded code is preferred wherever possible
- Closures should be avoided whenever possible
- Numerical functionality should use the appropriate generic numerical interfaces
- Functions should capture one underlying principle
- Internal choices should be exposed as options whenever possible
- Prefer code reuse over rewrites whenever possible
- Prefer to not shadow functions
- Troubleshooting