Review checklist

General checks

• [X] Repository: Is the source code for this software available at the repository url?
• [X] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• [X] Contribution and authorship: Has the submitting author made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

• [X] Installation: Does installation proceed as outlined in the documentation?

  • [ ] Modificar a pagina de instalacao para ter uma instalacao mais manual.

• [ ] Functionality: Have the functional claims of the software been confirmed?

  • [ ] Listar as funcionalidades
  • [ ] Confirm the functional claims

• [X] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• [ ] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• [X] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• [X] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• [ ] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• [ ] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• [ ] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• [ ] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• [ ] A statement of need: Does the paper have a section titled ‘Statement of need’ that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
• [ ] State of the field: Do the authors describe how this software compares to other commonly-used packages?
• [ ] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• [ ] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

AbEC is a Component-based Framework for Research and Development in Static and Dynamic Evolutionary Computation

|Build status| |Coverage Status|

Documentation

The documentation for AbEC is hosted on Read the docs.

Installation and Dependencies

The easiest way to get AbEC is to install cloning the reposity from github.

The recommended install method is to use git clone:

git clone https://github.com/AbEC-EC/AbEC.git

See the installation instructions in the documentation for more information.

Attribution

|JOSS| |DOI|

If you make use of this code, please cite the JOSS paper:

@article{abec,
  doi = {xx.xxxxxxx/joss.xxxxx},
  url = {https://doi.org/xx.xxxxxx/joss.xxxxx},
  year = 2024,
  month = {xxx},
  publisher = {The Open Journal},
  volume = {x},
  number = {xx},
  author = {Alexandre Mascarenhas},
  title = {AbEC - Adjustable Evolutionary Components: A Component-based Framework for Research and Development in Static and Dynamic Evolutionary Computation },
  journal = {The Journal of Open Source Software}
}

Please also cite the Zenodo DOI |DOI| as a software citation - see the documentation for up to date citation information.

License

Copyright 2024 Alexandre Mascarenhas and contributors.

AbEC is free software made available under the MIT License. For details see the LICENSE file.

Contributors

See the AUTHORS.rst file for a complete list of contributors to the project.