-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the CodeRunner wiki!
CodeRunner is a framework for the automated running and analysis of simulations. It automatically generates any necessary input files, organises the output data and analyses it. Because it is a modular system, it can easily be customised to work with any system and any simulation code. One of its greatest strengths is that it is independent of any one simulation code; thus it can easily plot and compare the data from different codes.
No more endless disorganised folders containing runs that you cannot remember! No more obscure scripts for submitting runs on a myriad of different HPC systems. No more copying and pasting columns of data from different files in order to plot them!
When plotting graphs CodeRunner collects data and stores it in a software independent form called a graphkit. This means that CodeRunner is not tied to a particular plotting or visualisation package. These graphkits will eventually be able to interface with most popular visualisation packages.
CodeRunner is currently very much an alpha. However, though it is early in the development process, it is fully functional and ready for use.
CodeRunner strives to always satisfy the following formula:
Standard tasks should be easy; non-standard tasks should be possible
Using CodeRunner the basic tasks of running simulations and performing standard analyis and plotting simple graphs are very easy to do. If you want to run some complicated analysis, or plot a customised graph, it is perfectly possible, but will require a little more work.
Using CodeRunner you can:
- Submit simulation runs in a single line
$ coderunner sub -p '{a: 20, b: 30}' -n 4x8 -W 500
- Plot graphs in a single line
$ coderunner plot -g eigenfunction
- Get a useful summary of all simulations in a given folder
$ coderunner st
CodeRunner
- Automatically analyses results
- Automatically organises run data
[CodeRunner Tutorial] - Quickly get to grips with CodeRunner basics.
[CodeRunner Command Line Manual]
[Understanding the CodeRunner Framework] - Learn more about the way that CodeRunner works.
[API (rdoc) Documentation] - Source code documentation.
[Glossary] - A dictionary of CodeRunner jargon.
[Creating a new system module] - How to add support for a system that CodeRunner currently does not support.
[Creating a new code module] - How to add support for a code that CodeRunner currently does not support.
If you would like to get involved feel free to fork, make your changes and submit a pull request.