Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cicirello/permutation-crossover-landscape-analysis

Experiments for paper: A Survey and Analysis of Evolutionary Operators for Permutations
https://github.com/cicirello/permutation-crossover-landscape-analysis

crossover crossover-operators fitness-landscape-analysis mutation mutation-operators permutations

Last synced: 23 days ago
JSON representation

Experiments for paper: A Survey and Analysis of Evolutionary Operators for Permutations

Awesome Lists containing this project

README

        

# permutation-crossover-landscape-analysis

Copyright © 2023 Vincent A. Cicirello

This repository contains code to reproduce the experiments, and analysis of
experimental data, from the following paper:

> Vincent A. Cicirello. 2023. [A Survey and Analysis of Evolutionary Operators for Permutations](https://www.cicirello.org/publications/cicirello2023ecta.pdf). In *Proceedings of the 15th International Joint Conference on Computational Intelligence*, pages 288-299. doi:[10.5220/0012204900003595](https://doi.org/10.5220/0012204900003595).

| __Related Publication__ | [![doi:10.5220/0012204900003595](doi.svg)](https://doi.org/10.5220/0012204900003595) |
| :--- | :--- |
| __License__ | [![GitHub](https://img.shields.io/github/license/cicirello/permutation-crossover-landscape-analysis)](LICENSE) |
| __Packages and Releases__ | [![Maven Central](https://img.shields.io/maven-central/v/org.cicirello/permutation-crossover-landscape-analysis.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/org.cicirello/permutation-crossover-landscape-analysis/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/cicirello/permutation-crossover-landscape-analysis?logo=GitHub)](https://github.com/cicirello/permutation-crossover-landscape-analysis/releases) |

## Dependencies

The experiments depend upon the following libraries, and in some cases this research has
also contributed to these libraries:
* [Chips-n-Salsa](https://chips-n-salsa.cicirello.org)
* [JavaPermutationTools](https://jpt.cicirello.org)

## Requirements to Build and Run the Experiments

To build and run the experiments on your own machine, you will need the following:
* __JDK 17__: I used OpenJDK 17, but other distributions should be fine.
* __Apache Maven__: In the root of the repository, there is a `pom.xml`
for building the Java programs for the experiments. Using this `pom.xml`,
Maven will take care of downloading the exact version of
[Chips-n-Salsa](https://chips-n-salsa.cicirello.org) (release 6.4.0) and its
dependencies that were used in the experiments.
* __Python 3__: The repository contains Python programs that were used to
process the raw data for the paper. If you want to run the Python programs,
you will need Python 3.
* __Make__: The repository contains a Makefile to simplify running the build,
running the experiment's Java programs, and running the Python program to
analyze the data. If you are familiar with using the Maven build tool,
and running Python programs, then you can just run these directly, although
the Makefile may be useful to see the specific commands needed.

## Building the Java Programs (Option 1)

The source code of the Java programs implementing the experiments
is in the [src/main/java](src/main/java) directory. You can build the experiment
programs in one of the following ways.

__Using Maven__: Execute the following from the root of the repository.

```shell
mvn clean package
```

__Using Make__: Or, you can execute the following from the root
of the repository.

```shell
make build
```

## Downloading a prebuilt jar (Option 2)

As an alternative to building the jar (see above), you can choose to instead
download a prebuilt jar of the experiments from the Maven Central repository.
The Makefile contains a target that will do this for you, provided that you have
curl installed on your system. To download the jar of the precompiled code of
the experiments, run the following from the root of the repository:

```shell
make download
```

The jar that it downloads contains the compiled code of the experiments as well
as all dependencies within a single jar file.

## Running the Experiments

If you just want to inspect the data from my runs, then you can find that output
in the [/data](data) directory. If you instead want to run the experiments yourself,
you must first either follow the build instructions or download a prebuilt jar (see above
sections). Once the jar of the experiments is either built or downloaded, you can then run
the experiments with the following executed at the root of the repository:

```shell
make experiments
```

If you don't want to overwrite my original data files, then first change the variable
`pathToDataFiles` in the `Makefile` before running the above command.

## Analyzing the Experimental Data

To run the Python program that I used to process the raw data,
and generate the figures for the paper, you need Python 3 installed. The source
code of the Python programs is found in the [src/main/python](src/main/python)
directory. To run the analysis, execute the following at the root of the
repository:

```shell
make analysis
```

If you don't want to overwrite my original data files, and figures, then change the
variable `pathToDataFiles` in the `Makefile` before running the above command.

This will analyze the data from the [/data](data) directory. It will also
generate the figures, etc in that directory. This make command will also take
care of installing any required Python packages if you don't already have them
installed.

## Other Files in the Repository

There are a few other files, potentially of interest, in the repository,
which include:
* `system-stats.txt`: This file contains details of the system I
used to run the experiments, such as operating system, processor
specs, Java JDK and VM. It is in the [/data](data) directory.

## License

The code to replicate the experiments from the paper, as well as the
Chips-n-Salsa library is licensed under the [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).