Skip to content

Commit

Permalink
Add description to seeds package (#23, #27)
Browse files Browse the repository at this point in the history
  • Loading branch information
a5kin committed Feb 2, 2018
1 parent ac298a8 commit 1dce29f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions xentica/seeds/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
"""
The package helping you to construct initial CA state (seed).
Classes from modules below are intended for use in
:class:`Experiment <xentica.core.experiments.Experiment>` classes.
For example to initialize the whole board with random values::
from xentica import core, seeds
class MyExperiment(core.Experiment):
# ...
seed = seeds.patterns.PrimordialSoup(
vals={
"state": seeds.random.RandInt(0, 1),
}
)
"""

from xentica.seeds import random
from xentica.seeds import patterns

Expand Down

0 comments on commit 1dce29f

Please sign in to comment.