Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 6afe0af

Browse filesBrowse files
firefly-cppfirefly-cpp
authored
Merge pull request #21 from lahovniktadej/master
README
2 parents 79fca91 + 1aa98df commit 6afe0af
Copy full SHA for 6afe0af

File tree

Expand file treeCollapse file tree

1 file changed

+39
-24
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+39
-24
lines changed

β€ŽREADME.md

Copy file name to clipboardExpand all lines: README.md
+39-24Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,48 @@
22
<img width="200" src="https://raw.githubusercontent.com/firefly-cpp/FireflyAlgorithm/master/.github/imgs/firefly_logo.png">
33
</p>
44

5-
---
5+
<h1 align="center">
6+
Firefly Algorithm --- Implementation of Firefly algorithm in Python
7+
</h1>
68

7-
# Firefly Algorithm --- Implementation of Firefly algorithm in Python
9+
<p align="center">
10+
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/fireflyalgorithm.svg" href="https://pypi.python.org/pypi/fireflyalgorithm">
11+
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/fireflyalgorithm.svg">
12+
<img alt="Downloads" src="https://img.shields.io/pypi/dm/fireflyalgorithm.svg">
13+
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/firefly-cpp/FireflyAlgorithm">
14+
<img alt="AUR package" src="https://img.shields.io/aur/version/python-fireflyalgorithm?color=blue&label=Arch%20Linux&logo=arch-linux" href="https://aur.archlinux.org/packages/python-fireflyalgorithm">
15+
<img alt="GitHub license" src="https://img.shields.io/github/license/firefly-cpp/FireflyAlgorithm.svg" href="https://github.com/firefly-cpp/FireflyAlgorithm/blob/master/LICENSE">
16+
<img alt="build" src="https://github.com/firefly-cpp/FireflyAlgorithm/actions/workflows/test.yml/badge.svg">
17+
</p>
818

9-
---
19+
<p align="center">
20+
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/firefly-cpp/FireflyAlgorithm.svg">
21+
<img alt="Average time to resolve an issue" src="http://isitmaintained.com/badge/resolution/firefly-cpp/FireflyAlgorithm.svg" href="http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm">
22+
<img alt="Percentage of issues still open" src="http://isitmaintained.com/badge/open/firefly-cpp/FireflyAlgorithm.svg" href="http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm">
23+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/firefly-cpp/FireflyAlgorithm.svg">
24+
<img alt="Packaging status" src="https://repology.org/badge/tiny-repos/python:fireflyalgorithm.svg" href="https://repology.org/project/python:fireflyalgorithm/versions">
25+
</p>
1026

11-
[![PyPI Version](https://img.shields.io/pypi/v/fireflyalgorithm.svg)](https://pypi.python.org/pypi/fireflyalgorithm)
12-
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fireflyalgorithm.svg)
13-
![PyPI - Downloads](https://img.shields.io/pypi/dm/fireflyalgorithm.svg)
14-
[![Downloads](https://pepy.tech/badge/fireflyalgorithm)](https://pepy.tech/project/fireflyalgorithm)
15-
![GitHub repo size](https://img.shields.io/github/repo-size/firefly-cpp/FireflyAlgorithm?style=flat-square)
16-
[![AUR package](https://img.shields.io/aur/version/python-fireflyalgorithm?color=blue&label=Arch%20Linux&logo=arch-linux)](https://aur.archlinux.org/packages/python-fireflyalgorithm)
17-
[![GitHub license](https://img.shields.io/github/license/firefly-cpp/FireflyAlgorithm.svg)](https://github.com/firefly-cpp/FireflyAlgorithm/blob/master/LICENSE)
18-
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/firefly-cpp/FireflyAlgorithm.svg)
19-
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/firefly-cpp/FireflyAlgorithm.svg)](http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm "Average time to resolve an issue")
20-
[![Percentage of issues still open](http://isitmaintained.com/badge/open/firefly-cpp/FireflyAlgorithm.svg)](http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm "Percentage of issues still open")
21-
![GitHub contributors](https://img.shields.io/github/contributors/firefly-cpp/FireflyAlgorithm.svg)
22-
[![Packaging status](https://repology.org/badge/tiny-repos/python:fireflyalgorithm.svg)](https://repology.org/project/python:fireflyalgorithm/versions)
23-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10430919.svg)](https://doi.org/10.5281/zenodo.10430919)
27+
<p align="center">
28+
<img alt="DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.10430919.svg" href="https://doi.org/10.5281/zenodo.10430919">
29+
</p>
30+
31+
<p align="center">
32+
<a href="#-about">πŸ“‹ About</a> β€’
33+
<a href="#-installation">πŸ“¦ Installation</a> β€’
34+
<a href="#-usage">πŸš€ Usage</a> β€’
35+
<a href="#-reference-papers">πŸ“š Reference Papers</a> β€’
36+
<a href="#-cite-us">πŸ“„ Cite us</a> β€’
37+
<a href="#-license">πŸ”‘ License</a>
38+
</p>
2439

25-
## About πŸ“‹
40+
## πŸ“‹ About
2641

2742
This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language. πŸŒΏπŸ”πŸ’»
2843

29-
## Installation πŸ“¦
44+
## πŸ“¦ Installation
3045

31-
Install FireflyAlgorithm with pip:
46+
To install FireflyAlgorithm with pip, use:
3247
```sh
3348
pip install fireflyalgorithm
3449
```
@@ -40,12 +55,12 @@ To install FireflyAlgorithm on Arch Linux, please use an [AUR helper](https://wi
4055
```sh
4156
$ yay -Syyu python-fireflyalgorithm
4257
```
43-
To install FireflyAlgorithm on Alpine Linux:
58+
To install FireflyAlgorithm on Alpine Linux, use:
4459
```sh
4560
$ apk add py3-fireflyalgorithm
4661
```
4762

48-
## Usage πŸš€
63+
## πŸš€ Usage
4964

5065
```python
5166
from fireflyalgorithm import FireflyAlgorithm
@@ -105,18 +120,18 @@ options:
105120
**Note:** The CLI script can also run as a python module (python -m fireflyalgorithm ...).
106121

107122

108-
## Reference Papers πŸ“š
123+
## πŸ“š Reference Papers
109124

110125
I. Fister Jr., X.-S. Yang, I. Fister, J. Brest. [Memetic firefly algorithm for combinatorial optimization](http://www.iztok-jr-fister.eu/static/publications/44.pdf) in Bioinspired Optimization Methods and their Applications (BIOMA 2012), B. Filipic and J.Silc, Eds.
111126
Jozef Stefan Institute, Ljubljana, Slovenia, 2012
112127

113128
I. Fister, I. Fister Jr., X.-S. Yang, J. Brest. [A comprehensive review of firefly algorithms](http://www.iztok-jr-fister.eu/static/publications/23.pdf). Swarm and Evolutionary Computation 13 (2013): 34-46.
114129

115-
## Cite us
130+
## πŸ“„ Cite us
116131

117132
Fister Jr., I., Pečnik, L., & Stupan, Ž. (2023). firefly-cpp/FireflyAlgorithm: 0.4.3 (0.4.3). Zenodo. [https://doi.org/10.5281/zenodo.10430919](https://doi.org/10.5281/zenodo.10430919)
118133

119-
## License
134+
## πŸ”‘ License
120135

121136
This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.
122137

0 commit comments

Comments
0Β (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.