Skip to content

Commit 6b4d34a

Browse files
committed
Update readme file
1 parent 39b036d commit 6b4d34a

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Crates.io Version](https://img.shields.io/crates/v/virolution?style=for-the-badge)](https://crates.io/crates/virolution)
44
[![docs.rs](https://img.shields.io/docsrs/virolution?style=for-the-badge)](https://docs.rs/virolution)
55
[![GitHub Branch](https://img.shields.io/github/check-runs/sirno/virolution/main?style=for-the-badge)](https://github.com/sirno/virolution/actions)
6+
<!-- cargo-rdme start -->
67

78
## Virolution - Agent-Based Simulation of Viral Evolution
89

@@ -66,18 +67,17 @@ parameters:
6667
- [1.0, 0.0, 1.0, 1.0]
6768
- [1.0, 1.0, 0.0, 1.0]
6869
- [1.0, 1.0, 1.0, 0.0]
69-
host_fitness: !SingleHost
70-
reproductive:
71-
distribution: !Exponential
72-
weights:
73-
beneficial: 0.29
74-
deleterious: 0.51
75-
lethal: 0.2
76-
neutral: 0.0
77-
lambda_beneficial: 0.03
78-
lambda_deleterious: 0.21
79-
utility: !Algebraic
80-
upper: 1.5
70+
host_model: !SingleHost
71+
distribution: !Exponential
72+
weights:
73+
beneficial: 0.29
74+
deleterious: 0.51
75+
lethal: 0.2
76+
neutral: 0.0
77+
lambda_beneficial: 0.03
78+
lambda_deleterious: 0.21
79+
utility: !Algebraic
80+
upper: 1.5
8181
schedule:
8282
- generation: "{} % 1"
8383
event: transmission
@@ -101,8 +101,9 @@ between two compartments. The sample event will occur every 200 generations and
101101
the current generation number and an event will be executed whenever the expression evaluates
102102
to 0.
103103

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).
104+
There are more parameters and events that can be configured in the schedule. For more
105+
information on the configuration, see the
106+
[documentation](https://docs.rs/virolution/latest/virolution/config/index.html).
106107

107108
When the simulation is complete (reached its maximum generation), the final population will be
108109
stored in a file called `final.<i>.csv`, where `<i>` is the compartment number. The file will
@@ -120,8 +121,9 @@ and recombinants can be derived:
120121
use std::sync::Arc;
121122
122123
use virolution::core::*;
123-
use virolution::core::fitness::init::*;
124-
use virolution::core::fitness::utility::*;
124+
use virolution::init::fitness::*;
125+
use virolution::core::fitness::UtilityFunction;
126+
use virolution::providers::FitnessProvider;
125127
use virolution::encoding::Nucleotide as Nt;
126128
127129
let sequence = vec![Nt::A; 4];
@@ -146,3 +148,4 @@ assert_eq!(mutant2.get_sequence(), vec![Nt::A, Nt::G, Nt::C, Nt::A]);
146148
assert_eq!(recombinant.get_sequence(), vec![Nt::A, Nt::A, Nt::C, Nt::A]);
147149
```
148150

151+
<!-- cargo-rdme end -->

0 commit comments

Comments
 (0)