timofej/neuropercolation
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates Readme

Browse Source
This commit is contained in:
rfeistenauer 2020-10-20 14:11:16 +02:00
parent 55c5bc2d81
commit edd1211692
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -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.