Skip to content

Commit

Permalink
Add directions on replicating the paper results on github
Browse files Browse the repository at this point in the history
  • Loading branch information
itsikelis committed Aug 11, 2024
1 parent 544f45f commit f1f2a5f
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,54 @@ If you use this code in a scientific publication, please use the following citat
}
```

## Replicating the paper results

Clone this repository.

```shell
git clone [email protected]:NOSALRO/cregopt.git
```

The required libraries are added as submodules.

```shell
cd cregopt/.ci/
git submodule init
git submodule update
```

\*This code uses the HSL_MA97 parallel solver package for IPOPT, which is licensed \(more info [here](https://licences.stfc.ac.uk/product/coin-hsl)\). If you have the .zip file, you should extract its contents in the .ci/coinshl folder.

Build the docker image.

```shell
docker build -t ipopt .
```

Start the docker container.

```shell
cd .. # cd to the project root directory
docker run --rm -it --net=host -e DISPLAY -v ${HOME}/.Xauthority:/home/robot/.Xauthority -v "$(pwd)":/home/robot/code --entrypoint /bin/bash ipopt
```

In the docker container build the experiment executables and run the bash script that generates and stores the resutls.

```shell
cd code/
mkdir build && cd build
cmake ..
make -j
cd ..# cd to project's root directory
cd tools/

./run_experiment_1 # Run 1st paper experiment.
./run_experiment_2 # Run 2nd paper experiment.
./run_experiment_3 # Run 3rd paper experiment.
```

The experiment results will be automatically exported in the [project root directory]/tools/results in csv form.

## Acknowledgments

This work was supported by the [Hellenic Foundation for Research and Innovation](https://www.elidek.gr/en/homepage/) (H.F.R.I.) under the "3rd Call for H.F.R.I. Research Projects to support Post-Doctoral Researchers" (Project Acronym: NOSALRO, Project Number: 7541).
Expand Down

0 comments on commit f1f2a5f

Please sign in to comment.