Merge pull request #8 from ahmedkhalf/develop

🥳First Release 0.1 🥳

.github/ISSUE_TEMPLATE/ask-a-question.md

@@ -0,0 +1,10 @@
+---
+name: Ask a question
+about: Ask questions related to your code and this project.
+title: ''
+labels: question
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - Version [e.g. 0.1]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -122,8 +122,8 @@ further defined and clarified by project maintainers.
 ### Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
-complaints will be reviewed and investigated and will result in a response that
+reported by contacting the project team.
+All complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.

README.md

@@ -1,9 +1,75 @@
-# Circle Evolution
- Evolutionary Art Using Circles
+<p align="center">
+    <br>
+    <img src="docs/images/logo.png" width="500"/>
+    <br>
+<p>
+<p align="center">
+    <a href="#">
+        <img alt="Contributions - Welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen">
+    </a>
+    <a href="https://github.com/ahmedkhalf/Circle-Evolution/stargazers">
+        <img alt="GitHub stars" src="https://img.shields.io/github/stars/ahmedkhalf/Circle-Evolution">
+    </a>
+    <a href="https://github.com/ahmedkhalf/Circle-Evolution/network/members">
+        <img alt="GitHub forks" src="https://img.shields.io/github/forks/ahmedkhalf/circle-evolution">
+    </a>
+    <a href="https://github.com/ahmedkhalf/Circle-Evolution/blob/master/LICENSE">
+        <img alt="License" src="https://img.shields.io/github/license/ahmedkhalf/circle-evolution">
+    </a>
+</p>
+<h3 align="center">
+Evolutionary Art Using Circles
+</h3>
 
-# Contributors
+# Getting Started
+## Installation
 
-Ahmed
+Clone or download this repository then run this command in the root folder
+```bash
+python setup.py install
+```
+
+## Usage
+### Command Line
+
+You can easily start training an image by calling circle_evolution from your terminal
+
+**Example:**
+```bash
+circle_evolution "Mona Lisa 64.jpg" --size 1 --genes 256 --max-generations 50000
+```
+
+| Parameter         | Description                                                          |
+| ----------------- | -------------------------------------------------------------------- |
+| --size            | Image size {1: (64, 64), 2: (128, 128), 3: (256, 256)}. *Default: 2* |
+| --genes           | Number of circle to fit. *Default: 256*                              |
+| --max-generations | Number of generations to run. *Default: 500,000*                     |
+
+### Python Example Script
+
+```python
+from circle_evolution import evolution
+from circle_evolution import helpers
+import numpy as np
+import cv2
+
+target = helpers.load_target_image("Mona Lisa 64.jpg", size=(64, 64))
+e = evolution.Evolution((64, 64), target)
+
+e.evolve(max_generation=50000)
+
+helpers.show_image(e.specie.phenotype)
+
+np.savetxt("Checkpoint.txt", e.specie.genotype)
+cv2.imwrite("OuputImage.jpg", e.specie.phenotype)
+```
+# Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Contributors
+
+Ahmed Khalf
 [ahmedkhalf](http://github.com/ahmedkhalf)
 
 Guilherme de Amorim

circle_evolution/__init__.py

@@ -1 +1,101 @@
-__version__ = "0.0.dev"
+"""
+# Welcome to Circle Evolution's Documentation
+
+<p>
+    <img alt="Circle Evolution Logo" src="images/logo.png" width="400">
+</p>
+
+# Know your terminology
+
+A specie in Circle Evolution is the object we are optimizing.
+A specie has both a genotype and a phenotype.
+
+The specie's genotype tells the renderer how the circles should be rendered.
+
+The specie's phenotype is the rendered image itself.
+
+# Getting Started
+## Installation
+
+Clone or download this repository then run this command in the root folder
+```bash
+python setup.py install
+```
+
+## Usage
+### Command Line
+
+You can easily start training an image by calling circle_evolution from your terminal
+
+**Example:**
+```bash
+circle_evolution "Mona Lisa 64.jpg" --size 1 --genes 256 --max-generations 50000
+```
+
+| Parameter         | Description                                                          |
+| ----------------- | -------------------------------------------------------------------- |
+| --size            | Image size {1: (64, 64), 2: (128, 128), 3: (256, 256)}. *Default: 2* |
+| --genes           | Number of circle to fit. *Default: 256*                              |
+| --max-generations | Number of generations to run. *Default: 500,000*                     |
+
+### Python Example Scripts
+
+This script is the equivalent of running the command mentioned above.
+
+```python
+from circle_evolution import evolution
+from circle_evolution import helpers
+import numpy as np
+import cv2
+
+# Load target image of size (64, 64)
+target = helpers.load_target_image("Mona Lisa 64.jpg", size=(64, 64))
+
+# Setup evolution
+e = evolution.Evolution((64, 64), target)
+
+# Evolve for 50k generations
+e.evolve(max_generation=50000)
+
+# Show evolved phenotype
+helpers.show_image(e.specie.phenotype)
+
+# Saves genotype to checkpoint
+np.savetxt("Checkpoint.txt", e.specie.genotype)
+
+# Saves phenotype
+cv2.imwrite("OuputImage.jpg", e.specie.phenotype)
+```
+
+Here is how to load and train further from a saved checkpoint.
+
+```python
+from circle_evolution import evolution
+from circle_evolution import helpers
+import numpy as np
+import cv2
+
+# Load target image of size (64, 64)
+target = helpers.load_target_image("Mona Lisa 64.jpg", size=(64, 64))
+
+# Setup evolution
+e = evolution.Evolution((64, 64), target)
+
+# Load from checkpoint
+genes = np.loadtxt("Checkpoint.txt")
+e.specie.genotype = genes
+
+# Evolve for 50k generations
+e.evolve(max_generation=50000)
+
+# Show evolved phenotype
+helpers.show_image(e.specie.phenotype)
+```
+
+# Contributing
+
+Pull requests are welcome.
+For major changes, please open an issue first to discuss what you would like to change.
+"""
+
+__version__ = "0.1"