Prepare 1.0.0 release

This commit is contained in:
rfeistenauer 2020-10-20 13:57:04 +02:00
parent e65aa294fe
commit 55c5bc2d81
2 changed files with 9 additions and 7 deletions

View File

@ -27,7 +27,7 @@ The speed optimization and multi process capability was more of challenge for my
IMHO the module now reached an acceptable speed, but there is still room for improvements (e.g. with Numba?). IMHO the module now reached an acceptable speed, but there is still room for improvements (e.g. with Numba?).
### Changelog ### Changelog
#### 0.3.0 #### 1.0.0
With the new changes I could improve the speed drastically: With the new changes I could improve the speed drastically:
Creation time: * 1/2 Creation time: * 1/2
Processing time: * 1/15 Processing time: * 1/15
@ -114,11 +114,13 @@ There ist still quite some work to do.
And for all others, don't hesitate to open issues when you have problems! And for all others, don't hesitate to open issues when you have problems!
## Dependencies ## Dependencies
For direct usage of the cellular automaton there is no dependency. There is only a dependency for [recordclass](https://pypi.org/project/recordclass/) at the moment.
If you want to use the display option however or execute the examples you will have to install
If you want to use the CAWindow or execute the examples you will have to install
[pygame](https://www.pygame.org/news) for visualisation. [pygame](https://www.pygame.org/news) for visualisation.
If you do for some reason not want to use this engine simply inherit from display.DrawEngine and overwrite the If you don't want to use this engine for some reason pass another draw_ending to the CAWindow.
necessary methods. (for an example of how to do so see ./test/test_display.py) It has to provides the same interface as the [PygameEngine](https://gitlab.com/DamKoVosh/cellular_automaton/-/blob/master/cellular_automaton/display.py)
## Licence ## Licence
This package is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see [LICENSE.txt](https://gitlab.com/DamKoVosh/cellular_automaton/-/tree/master/LICENSE.txt) This package is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
see [LICENSE.txt](https://gitlab.com/DamKoVosh/cellular_automaton/-/tree/master/LICENSE.txt)

View File

@ -16,5 +16,5 @@ setup(
description="N dimensional cellular automaton.", description="N dimensional cellular automaton.",
long_description=long_description, long_description=long_description,
long_description_content_type='text/markdown', long_description_content_type='text/markdown',
requires=["Python (>3.6.1)", "recordclass", "pytest"] requires=["Python (>3.6.1)", "recordclass"]
) )