Metadata-Version: 1.1
Name: cellular_automaton
Version: 0.1.3
Summary: N dimensional cellular automaton with multi processing capability.
Home-page: https://gitlab.com/DamKoVosh/cellular_automaton
Author: Richard Feistenauer
Author-email: r.feistenauer@web.de
License:                                  Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
Description: # Cellular Automaton
        This package provides an cellular automaton for [`Python® 3`](https://www.python.org/)
        
        A cellular automaton defines a grid of cells and a set of rules.
        All cells then evolve their state depending on their neighbours state simultaneously.
        
        For further information on cellular automatons consult e.g. [mathworld.wolfram.com](http://mathworld.wolfram.com/CellularAutomaton.html)
        
        ## Yet another cellular automaton module?
        It is not the first python module to provide a cellular automaton, 
        but it is to my best knowledge the first that provides all of the following features:
         - easy to use
         - n dimensional
         - multi process capable
         - speed optimized
         - documented
         - tested
         
        I originally did not plan to write a new cellular automaton module, 
        but when searching for one, I just found some minimalistic implementations,
        that had little or no documentation with an API that really did not fit the problem
        and Code that was desperately asking for some refactoring.
        
        So I started to write my own module with the goal to provide an user friendly API
        and acceptable documentation. During the implementation I figured, why not just provide 
        n dimensional support and with reading Clean Code from Robert C. Martin the urge
        to have a clean and tested code with a decent coverage added some more requirements.
        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.
        
        ## Usage
        To start and use the automaton you will have to define three things:
        - The neighborhood
        - The dimensions of the grid
        - The evolution rule
        
        `````python
        neighborhood = MooreNeighborhood(EdgeRule.IGNORE_EDGE_CELLS)
        ca = CAFactory.make_single_process_cellular_automaton(dimension=[100, 100],
                                                              neighborhood=neighborhood,
                                                              rule=MyRule)
        ``````
        
        ### Neighbourhood
        The Neighborhood defines for a cell neighbours in relative coordinates.
        The evolution of a cell will depend solely on those neighbours.
         
        The Edge Rule passed as parameter to the Neighborhood defines, how cells on the edge of the grid will be handled.
        There are three options:
        - Ignore edge cells: Edge cells will have no neighbours and thus not evolve.
        - Ignore missing neighbours: Edge cells will add the neighbours that exist. This results in varying count of neighbours on edge cells.
        - First and last cell of each dimension are neighbours: All cells will have the same neighbour count and no edge exists.
        
        ### Dimension
        A list or Tuple which states each dimensions size.
        The example above defines a two dimensional grid with 100 x 100 cells.
        
        There is no limitation in how many dimensions you choose but your memory and processor power.
        
        ### Rule
        The Rule has three tasks:
        - Set the initial value for all cells.
        - Evolve a cell in respect to its neighbours.
        - (optional) define how the cell should be drawn.
        
        `````python
        class MyRule(Rule):
        
            def init_state(self, cell_coordinate):
                return (1, 1)
        
            def evolve_cell(self, last_cell_state, neighbors_last_states):
                return self._get_neighbor_by_relative_coordinate(neighbors_last_states, (-1, -1))
        
            def get_state_draw_color(self, current_state):
                return [255 if current_state[0] else 0, 0, 0]
        `````
        
        Just inherit from `cellular_automaton.rule:Rule` and define the evolution rule and initial state.
        
        ## Visualisation
        The package provides a module for visualization in a pygame window for common two dimensional automatons.
        
        To add another kind of display option e.g. for other dimensions or hexagonal grids you can extrend the provided implementation or build your own.
        The visual part of this module is fully decoupled and thus should be easily replaceable.
        
        ## Examples
        The package contains two examples:
        - [simple_star_fall](./examples/simple_star_fall.py)
        - [conways_game_of_life](./examples/conways_game_of_life.py)
        
        Those two example automaton implementations should provide a good start for your own automaton.
        
        ## Dependencies
        As mentioned above the module depends on [pygame](https://www.pygame.org/news) for visualisation.
        This is the only dependency however.
        
        ## Licence
        This package is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see [LICENSE](./LICENSE.txt)
Platform: UNKNOWN
Requires: pygame
