/elastxy-framework

ElastXY Framework Repository

Primary LanguageJavaApache License 2.0Apache-2.0

ElastXY

This is the home of the ElastXY Framework, the foundation for all ElastXY projects.

ElastXY is an open, scalable, configurable Distributed Genetic Algorithm Framework for solving optimization and research problems, powered by Apache Spark.

Please read the Official Documentation for a more complete introduction, or visit Project Blog and Official Web Site.

Quick start

Try out the 10' Single Colony Tutorial for building your own app for local execution, or the 20' Multi Colony Tutorial for building a sample distributed application. IMPORTANT: Multi Colony Tutorial requires at least an application to work, which will be added in days.

Documentation

The ElastXY Framework currently maintains a single page reference Documentation on its website and a simple Changelog here for non trivial changes.

A Swagger UI is available when running locally (to be further polished).

In a near futures also Github wiki pages and an API reference will be made available through the web site, near guides and tutorials across ElastXY projects for all interesting use cases.

You may follow project by its Twitter account @elastxy to be notified.

Contributing and Code of conduct

Contributions are very welcome! You can contribute following project Contribution guidelines.

This project is governed by the project Code of Conduct. By participating you are expected to uphold this code. Please report unacceptable behavior to elastxy@mail.com.

Access to binaries

You can obtain current version of ElastXY Framework and related subprojects by building them locally (see Build from source section).

ElastXY binaries are not yet uploaded to Maven Central: when uploaded, you will be notified through this page or via @elastxy Twitter account.

Build from source

See the Build from source section of documentation page for building locally all necessary artifacts.

Stay in touch

You can follow the project on @elastxy on Twitter, or on its Blog. Releases or major progresses are announced via those channels.

Questions?

Open an Issue and let's chat!

License

The ElastXY Framework is released under version 2.0 of the Apache License.

You also may obtain a copy here: see LICENSE file.

Authors

  • Gabriele Rossi - Initial work - See Contact page on project web site.

See also the list of contributors who participated in this project.

Credits

  • Thanks to Apache Math3 library for CX (Cycle Crossover) operator implementation, from which I derived a CXD implementation also working with duplicates (opened issue).
  • My wife as an intelligent fount of inspiration, ElastXY logo creator and for the first user story.
  • All people liking, using, citing, criticizing and contributing to the project in every form.