Commit cbfc025e authored by Amaury BARRAL's avatar Amaury BARRAL

Update README.md

parent c2ba8270
......@@ -72,12 +72,20 @@ The available features are "quiver", "avg_speed", "avg_angle", "avg_polar", "ang
The available options are "max_group_size", "max_num_groups", "quiver_color_by_group", "quiver_color_single", "quiver_draw_by_group", "groups_num_ymin", "vel_scaling", detailed in the docstring
### Run an experiment remotely (SSH)
### Run one experiment remotely (SSH)
You can easily run experiments on any number of machines via SSH (for this purpose enabling loading/saving via Dropbox is particularly useful)
You can easily run experiments on remote machines via SSH (for this purpose enabling loading/saving via Dropbox is particularly useful), provided the remote machine has the repository cloned locally.
First of all, in _experiments.py_'s, modify _start_experiment_ so that it launches the experiment you want on the remote host given the function's parameters.
Then via ssh call ```python36 remote.py --file {filepath} --n {n_birds} --l {length} --eta {temperature} --t {total_time} --nb_exp {nb_exp} --vel {velocity}``` to launch _start_experiment_ with the parameters provided via the command line.
### Run several experiments remotely (SSH)
You can launch a series of experiments on several remote machines using the _ssh_experiments_ function in _experiments.py_. You need to fill in (inline, hardcoded) the IPs and login/pwd of the remote hosts, as well as the lists of parameters you want your experiments to cover, and the function will remotely distribute the experiments accross the machines.
Note that at the moment, other than checking for the presence or absence of result files, there is no way to know if an error occured along the way / if the experiments finished on the remote hosts.
## Contributing
We most likely won't accept external pull requests since we'll have other projects to work on in the future, but feel free to clone the repository and modify it.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment