Skip to content

Commit

Permalink
edits
Browse files Browse the repository at this point in the history
  • Loading branch information
fernandopalafox committed Apr 9, 2024
1 parent 2009175 commit 05081f4
Showing 1 changed file with 9 additions and 16 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,6 @@ Read the full paper [here](https://arxiv.org/abs/2311.09439).

## Quickstart Guide

**Installation**

This package uses the proprietary PATH solver under the hood (via [PATHSolver.jl](https://github.com/chkwon/PATHSolver.jl)).
Therefore, you will need a license key to solve larger problems.
However, by courtesy of Steven Dirkse, Michael Ferris, and Tudd Munson,
[temporary licenses are available free of charge](https://pages.cs.wisc.edu/~ferris/path.html).
Please consult the documentation of [PATHSolver.jl](https://github.com/chkwon/PATHSolver.jl) to learn about loading the license key.

## Running Experiments
To run your own experiments, start Julia at the repository root as `julia --project`. Then, run the following code:

```julia
julia> ] instantiate
julia> include("experiments/my_experiment.jl")
```

## Replicating paper visuals
If you would like to replicate the visualizations shown in the paper, run the following commands.
Going through the source code for the visualizations is also a good way of understanding how the code is structured.
Expand Down Expand Up @@ -71,6 +55,15 @@ julia> visualize_stage_1_cost()
julia> run_stage_1_breakout(display_controls = 0)
```

### A note on the solver

This package uses the proprietary PATH solver under the hood (via [PATHSolver.jl](https://github.com/chkwon/PATHSolver.jl)).
Therefore, you will need a license key to solve larger problems.
However, by courtesy of Steven Dirkse, Michael Ferris, and Tudd Munson,
[temporary licenses are available free of charge](https://pages.cs.wisc.edu/~ferris/path.html).
Please consult the documentation of [PATHSolver.jl](https://github.com/chkwon/PATHSolver.jl) to learn about loading the license key.


## Contact

> Note: For any questions on how to use this code, do not hesitate to reach out to Fernando Palafox at [[email protected]](mailto:[email protected]) or open an issue.

0 comments on commit 05081f4

Please sign in to comment.