File tree Expand file tree Collapse file tree 1 file changed +15
-3
lines changed Expand file tree Collapse file tree 1 file changed +15
-3
lines changed Original file line number Diff line number Diff line change @@ -43,8 +43,15 @@ virolution = "0.5"
43
43
44
44
### Basic Usage as a Binary
45
45
46
- After installation, you can run the binary with a sequence file and a configuration file. A
47
- configuration file may look like this:
46
+ To find all available options and their default values, you can run:
47
+
48
+ ``` shell
49
+ virolution --help
50
+ ```
51
+
52
+ The simulation can be run with a sequence file and a configuration file. A configuration file
53
+ provides the parameters for the simulation environment and the schedule for any events during
54
+ the simulation. It may look like this:
48
55
49
56
``` yaml
50
57
parameters :
@@ -94,7 +101,12 @@ between two compartments. The sample event will occur every 200 generations and
94
101
the current generation number and an event will be executed whenever the expression evaluates
95
102
to 0.
96
103
97
- There are more events that can be configured in the schedule.
104
+ There are more parameters and events that can be configured in the schedule. For more information
105
+ on the configuration, see the [documentation](https://docs.rs/virolution/latest/virolution/config/index.html).
106
+
107
+ When the simulation is complete (reached its maximum generation), the final population will be
108
+ stored in a file called `final.<i>.csv`, where `<i>` is the compartment number. The file will
109
+ contain all haplotypes and their respective counts.
98
110
99
111
# ## Basic Usage as a Library
100
112
You can’t perform that action at this time.
0 commit comments