https://github.com/zipfian-science/natural-selection
A library for pure Evolutionary Algorithm tools
https://github.com/zipfian-science/natural-selection
evolutionary-algorithms evolutionary-computation
Last synced: about 1 year ago
JSON representation
A library for pure Evolutionary Algorithm tools
- Host: GitHub
- URL: https://github.com/zipfian-science/natural-selection
- Owner: Zipfian-Science
- License: apache-2.0
- Created: 2020-08-21T14:54:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T17:25:09.000Z (over 3 years ago)
- Last Synced: 2025-03-21T21:11:22.479Z (over 1 year ago)
- Topics: evolutionary-algorithms, evolutionary-computation
- Language: Python
- Homepage:
- Size: 328 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Natural Selection
```
,(*
@@
*@ @@% *@
*@ @@ %@ @
@@/ @@ @@ @@
@@@(,@( @/ @@@@@@@&@@@@@
@ @& @@ /@@@#
/@ @@ ,@@ @@
,@@ @@ @@ @
%@@@ @@ @@@@@@@@@@@@@
,, @ @@ @@ &@@@
%@@ @@ &@@ @@
@%@@ &@@ @
,@,%@@
@@@@@@
_ _
_ __ __ _| |_ _ _ _ __ __ _| |
| '_ \ / _` | __| | | | '__/ _` | |
| | | | (_| | |_| |_| | | | (_| | |
|_| |_|\__,_|\__|\__,_|_| \__,_|_|
_ _ _
___ ___| | ___ ___| |_(_) ___ _ __
/ __|/ _ \ |/ _ \/ __| __| |/ _ \| '_ \
\__ \ __/ | __/ (__| |_| | (_) | | | |
|___/\___|_|\___|\___|\__|_|\___/|_| |_|
by Zipfian Science
```
Python tools for creating and running Evolutionary Algorithm (EA) experiments.
## Sauce layout
```
natural_selection
|
|- genetic_algorithms
| |- operators
| | |- selection
| | | |- elite_selection
| | | |- parent_selection
| | | |- survivor_selection
| | |
| | |- crossover
| | |- initialisation
| | |- mutation
| |
| |- utils
| |- criteria_stopping
| |- probability_functions
| |- random_functions
|
|- genetic_programs
| |- functions
| |- operators
| | |- initialisation
| |
| |- utils
|
|- deploy.py
|- run_tests.py
|- setup.py
```
## Run tests
To run unit tests, use the helper script `run_tests.py`.
```shell script
# To see available options
$ python run_tests.py -h
```
## Deploying
To build and deploy to PyPi, use the helper script `deploy.py`.
```shell script
# To see available options
$ python deploy.py -h
```
## Install and use
Once deployed, the package can be installed via pip.
```shell script
$ pip install natural-selection
```
## Branching dev repos
There are two main branches at any given point in time. These branches may only be pulled. These are:
- master
- dev
On creating a pull request for merging into dev or master, change reviews must be requested.
### master
This is the production branch and is considered the golden version. Production builds are deployed from this branch. Feature development will typically be pulled into the `release` branch first but bug fixes can be directly pulled into master.
### dev
This is the pre-release branch for merging tested and stable code. Although the branch is open for merging, it should still be done with communication throughout the team.
## Feature development branches
Feature development requires branches to be created and pushed remotely. When creating a new branch, the following naming convention should be followed:
> AA_description
Explanation:
- AA: the initials of the dev
- Description: short text describing the work or feature development
Example:
> JK_new_genetic_programming
This describes that this branch is being developed by JK (John Khoza) and that the nature of development is building a new idea in EA.
These branches have to be created from a local up to date `dev` branch, depending on where you start off a new development. Branches have to be pushed to the remote branch:
`JK_new_genetic_programming[local] -> JK_new_genetic_programming[remote]`
Merge requests into dev from feature development branches will be reviewed by a requested team member.
## Branching and keeping up to date
Example of branching:
```shell script
$ git checkout dev
$ git pull
$ git checkout -b AA_description
$ git commit
$ git push origin AA_description
```
In case of changes to dev, a git merge/rebase will bring your branch up to date with dev and avoid conflicts. For example:
```shell script
$ git checkout dev
$ git pull
$ git checkout AA_description
$ git merge dev
```
Alternatively, but not recommended:
```shell script
$ git checkout dev
$ git pull
$ git checkout AA_description
$ git rebase dev
```
## .gitignore
This is rather crucial to keep the repository clean. When any artefacts or files are created during development that don’t relate to run time code, please add these to the `.gitignore` file so that they are not added automatically. With that said, please commit the .gitignore file itself!
© [Zipfian Science](https://zipfian.science) 2022