https://github.com/db7/dude
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/db7/dude
- Owner: db7
- License: mit
- Created: 2025-03-14T16:59:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-14T17:17:03.000Z (over 1 year ago)
- Last Synced: 2025-03-14T18:36:37.897Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 508 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
====
Dude
====
The Dude is a framework to describe a set of configurations, to
execute them in experiments and to process the results into
summaries. Dude uses a description file in Python_ to prepare, execute
and summarize experiments.
.. _Python: https://www.python.org/
Installation
------------
For those who are getting it for the first time::
% hg clone https://bitbucket.org/db7/dude
In both cases, don't forget to install it afterwards. The installation
in /usr/local can be done with::
% sudo python setup.py install
To install in your $HOME (not su), you can use the --home option,
e.g.::
% python setup.py install --home=$HOME/local
This will copy the executable scripts in $HOME/local/bin and the
python libraries in $HOME/local/lib/python. You have to add these
paths to your PATH and PYTHONPATH environment variables, for example,
by adding the following in your .bashrc, .profile or .zshrc::
export PATH=$PATH:$HOME/local/bin
export PYTHONPATH=$PYTHONPATH:$HOME/local/lib/python
To test if everything is correctly installed, just type::
% dude
Workflow
--------
To get an idea of the workflow using Dude, the following lines will
give you a rough outline.
To work with Dude you first have to create a *Dudefile* where you
describe a set of experiments and how to summarize the data produced
by these experiments (the "examples" subdirectory may help you). Dude
has a command to create a Dudefile template for you::
% dude create
After you made your changes, you can run the experiments::
% dude run
You can run this command again when you discover that one experiment
crashed. Dude will only run experiments which were not already
executed or failed experiments. You can see all missing experiments by
issuing::
% dude missing
and all failed experiments::
% dude failed
If Dude is finished, you usually collect and process all data /
observations produced by your experiments. This is done by summarizing
your experiments::
% dude sum
You can use any tool you want to further process the final summaries.
Documentation
-------------
More details can be found in the `full documentation`_.
.. _full documentation: https://dude.readthedocs.org
Contribute
----------
Contributions or feedback in any form are welcome. Issues, bugs and
feature requests can be reported at:
https://bitbucket.org/db7/dude/issues