From edd12116923613c3253efe999a26162221d3ec84 Mon Sep 17 00:00:00 2001 From: rfeistenauer Date: Tue, 20 Oct 2020 14:11:16 +0200 Subject: [PATCH] Updates Readme --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index faa5776..687f592 100644 --- a/README.md +++ b/README.md @@ -26,24 +26,8 @@ to have a clean and tested code with a decent coverage added some more requireme The speed optimization and multi process capability was more of challenge for myself. IMHO the module now reached an acceptable speed, but there is still room for improvements (e.g. with Numba?). -### Changelog -#### 1.0.0 -With the new changes I could improve the speed drastically: -Creation time: * 1/2 -Processing time: * 1/15 - -I however omitted the multiprocessing capabilities. -Speed increase was minimal and the new structure allowing single processor to be that fast -does not yet support MP usage. - -The API did change! -- No separate factory anymore: Just create a CellularAutomaton(...) -- No Rule class anymore: Subclass CellularAutomaton and override `evolve_rule` and `init_cell_state` -- Cell color is now defined by the CAWindow `state_to_color_cb` parameter. -- Neighborhood does not need to know the dimension anymore - ## Installation -This module can be loaded and installed from [pipy](https://pypi.org/project/cellular-automaton/): `pip install cellular-automaton` +This module can be loaded and installed from [pypi](https://pypi.org/project/cellular-automaton/): `pip install cellular-automaton` ## Usage To start and use the automaton you will have to define four things: @@ -113,6 +97,22 @@ There ist still quite some work to do. And for all others, don't hesitate to open issues when you have problems! +## Changelog +#### 1.0.0 +- CI was added +- Coverage was increased +- Change project structure + - removed multiprocess capability + - reduced class count +- Improved algorithm to increase: + - creation time by factor of ~2 + - processing speed by factor of ~15 +- Changed API + - No separate factory anymore: Just create a CellularAutomaton(...) + - No Rule class anymore: Subclass CellularAutomaton and override `evolve_rule` and `init_cell_state` + - Cell color is now defined by the CAWindow `state_to_color_cb` parameter. + - Neighborhood does not need to know the dimension anymore + ## Dependencies There is only a dependency for [recordclass](https://pypi.org/project/recordclass/) at the moment.