SevgiAkten / pycellga

Cellular Genetic Algorithms in Python.
https://sevgiakten.github.io/pycellga/
MIT License
2 stars 1 forks source link

the readme.md file #18

Closed jbytecode closed 1 month ago

jbytecode commented 1 month ago

The repository already has a readme.md file

https://github.com/SevgiAkten/pycell/blob/main/README.md

but we need a more compherensive one.

Here is a list of well readme.md files for Python packages:

jbytecode commented 1 month ago

The README.md file has now section called Examples and the commit (https://github.com/SevgiAkten/pycellga/commit/da016136f4ca9d0e418d429929b829492f61073b) implements the skeleton.

Could you please follow the instructions and provide us some nice examples that show the unique capabilities of the package?

jbytecode commented 1 month ago

We can use the same code snippets in the manuscript, if possible.

SevgiAkten commented 1 month ago

I think the issue is also resolved.

jbytecode commented 1 month ago

README.md looks good. Nice work!

However, the examples should change a little bit, because the function signatures have been changed.

jbytecode commented 1 month ago

We can create a new section in README.md file like:

Citation

Please cite our work using the citation info

Karakaya, Sevgi Akten, and Mehmet Hakan Satman. "An Improved Cellular Genetic Algorithm with Machine-Coded Operators for Real-Valued Optimisation Problems." Journal of Engineering Research and Applied Science 13.1 (2024): 2500-2514.

or

@article{karakaya2024improved,
  title={An Improved Cellular Genetic Algorithm with Machine-Coded Operators for Real-Valued Optimisation Problems},
  author={Karakaya, Sevgi Akten and Satman, Mehmet Hakan},
  journal={Journal of Engineering Research and Applied Science},
  volume={13},
  number={1},
  pages={2500--2514},
  year={2024}
}