From e4976c0f12db7d184e71d2faec711b56c5e7e111 Mon Sep 17 00:00:00 2001 From: Iztok Fister Jr Date: Sun, 31 Dec 2023 22:57:23 +0100 Subject: [PATCH 1/6] Repo size badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f8cb55e..1d1a69a 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fireflyalgorithm.svg) ![PyPI - Downloads](https://img.shields.io/pypi/dm/fireflyalgorithm.svg) [![Downloads](https://pepy.tech/badge/fireflyalgorithm)](https://pepy.tech/project/fireflyalgorithm) +![GitHub repo size](https://img.shields.io/github/repo-size/firefly-cpp/FireflyAlgorithm?style=flat-square) [![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) [![GitHub license](https://img.shields.io/github/license/firefly-cpp/FireflyAlgorithm.svg)](https://github.com/firefly-cpp/FireflyAlgorithm/blob/master/LICENSE) ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/firefly-cpp/FireflyAlgorithm.svg) From ea450bb043951f488b3575872f1df51edbbfb8e7 Mon Sep 17 00:00:00 2001 From: Iztok Fister Jr Date: Thu, 4 Jan 2024 21:03:33 +0100 Subject: [PATCH 2/6] Add citation details in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1d1a69a..8c4a8c6 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,10 @@ Jozef Stefan Institute, Ljubljana, Slovenia, 2012 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. +## Cite us + +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) + ## License This package is distributed under the MIT License. This license can be found online at . From 79fca912def012796fea86e38bdee0cec95a11be Mon Sep 17 00:00:00 2001 From: Iztok Fister Jr Date: Tue, 6 Feb 2024 19:22:13 +0100 Subject: [PATCH 3/6] Add keywords in pyproject --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index b265e6b..01cd204 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,7 @@ name = "fireflyalgorithm" version = "0.4.4" description = "Implementation of Firefly Algorithm in Python" authors = ["Iztok Fister Jr. ", "Luka Pečnik ", "Žiga Stupan "] +keywords = ['computational intelligence', 'firefly algorithm', 'swarm intelligence', 'optimization'] license = "MIT" readme = "README.md" homepage = "https://github.com/firefly-cpp/FireflyAlgorithm" From 1aa98df0246ee75d39abd92be7f54c3000dbce92 Mon Sep 17 00:00:00 2001 From: Tadej Lahovnik Date: Mon, 22 Jul 2024 09:39:20 +0200 Subject: [PATCH 4/6] doc: README Table of contents --- README.md | 63 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 39 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8c4a8c6..527a1b2 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,48 @@

---- +

+Firefly Algorithm --- Implementation of Firefly algorithm in Python +

-# Firefly Algorithm --- Implementation of Firefly algorithm in Python +

+ PyPI Version + PyPI - Python Version + Downloads + GitHub repo size + AUR package + GitHub license + build +

---- +

+ GitHub commit activity + Average time to resolve an issue + Percentage of issues still open + GitHub contributors + Packaging status +

-[![PyPI Version](https://img.shields.io/pypi/v/fireflyalgorithm.svg)](https://pypi.python.org/pypi/fireflyalgorithm) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fireflyalgorithm.svg) -![PyPI - Downloads](https://img.shields.io/pypi/dm/fireflyalgorithm.svg) -[![Downloads](https://pepy.tech/badge/fireflyalgorithm)](https://pepy.tech/project/fireflyalgorithm) -![GitHub repo size](https://img.shields.io/github/repo-size/firefly-cpp/FireflyAlgorithm?style=flat-square) -[![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) -[![GitHub license](https://img.shields.io/github/license/firefly-cpp/FireflyAlgorithm.svg)](https://github.com/firefly-cpp/FireflyAlgorithm/blob/master/LICENSE) -![GitHub commit activity](https://img.shields.io/github/commit-activity/w/firefly-cpp/FireflyAlgorithm.svg) -[![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") -[![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") -![GitHub contributors](https://img.shields.io/github/contributors/firefly-cpp/FireflyAlgorithm.svg) -[![Packaging status](https://repology.org/badge/tiny-repos/python:fireflyalgorithm.svg)](https://repology.org/project/python:fireflyalgorithm/versions) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10430919.svg)](https://doi.org/10.5281/zenodo.10430919) +

+ DOI +

+ +

+ 📋 About • + 📦 Installation • + 🚀 Usage • + 📚 Reference Papers • + 📄 Cite us • + 🔑 License +

-## About 📋 +## 📋 About This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language. 🌿🔍💻 -## Installation 📦 +## 📦 Installation -Install FireflyAlgorithm with pip: +To install FireflyAlgorithm with pip, use: ```sh pip install fireflyalgorithm ``` @@ -40,12 +55,12 @@ To install FireflyAlgorithm on Arch Linux, please use an [AUR helper](https://wi ```sh $ yay -Syyu python-fireflyalgorithm ``` -To install FireflyAlgorithm on Alpine Linux: +To install FireflyAlgorithm on Alpine Linux, use: ```sh $ apk add py3-fireflyalgorithm ``` -## Usage 🚀 +## 🚀 Usage ```python from fireflyalgorithm import FireflyAlgorithm @@ -105,18 +120,18 @@ options: **Note:** The CLI script can also run as a python module (python -m fireflyalgorithm ...). -## Reference Papers 📚 +## 📚 Reference Papers 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. Jozef Stefan Institute, Ljubljana, Slovenia, 2012 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. -## Cite us +## 📄 Cite us 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) -## License +## 🔑 License This package is distributed under the MIT License. This license can be found online at . From d600ff884bf7fb98f0b1ad85242e58d41e7d5505 Mon Sep 17 00:00:00 2001 From: "Iztok Fister Jr." Date: Thu, 25 Jul 2024 12:12:10 +0200 Subject: [PATCH 5/6] Update references --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 527a1b2..b0a5485 100644 --- a/README.md +++ b/README.md @@ -122,10 +122,12 @@ options: ## 📚 Reference Papers -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. +I. Fister Jr., X.-S. Yang, I. Fister, J. Brest, D. Fister. [A Brief Review of Nature-Inspired Algorithms for Optimization](http://www.iztok-jr-fister.eu/static/publications/21.pdf). Elektrotehniški vestnik, 80(3), 116-122, 2013. + +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. Jozef Stefan Institute, Ljubljana, Slovenia, 2012 -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. +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. ## 📄 Cite us From b489f3515dd20b962219e700cf2f0421a0262f30 Mon Sep 17 00:00:00 2001 From: "Iztok Fister Jr." Date: Thu, 8 Aug 2024 14:00:49 +0200 Subject: [PATCH 6/6] Bump version and rebuilt --- fireflyalgorithm/__init__.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/fireflyalgorithm/__init__.py b/fireflyalgorithm/__init__.py index 52d052d..31626e8 100644 --- a/fireflyalgorithm/__init__.py +++ b/fireflyalgorithm/__init__.py @@ -2,4 +2,4 @@ __all__ = ["FireflyAlgorithm"] -__version__ = "0.4.4" +__version__ = "0.4.5" diff --git a/pyproject.toml b/pyproject.toml index 01cd204..4681382 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "fireflyalgorithm" -version = "0.4.4" +version = "0.4.5" description = "Implementation of Firefly Algorithm in Python" authors = ["Iztok Fister Jr. ", "Luka Pečnik ", "Žiga Stupan "] keywords = ['computational intelligence', 'firefly algorithm', 'swarm intelligence', 'optimization']