royerlab / ultrack

Cell tracking and segmentation software
https://royerlab.github.io/ultrack
BSD 3-Clause "New" or "Revised" License
86 stars 11 forks source link

Add gurobi documentation #62

Open tischi opened 8 months ago

tischi commented 8 months ago

Could you add some information here how to get and use the gurobi solver?

tischi commented 8 months ago

Do we also need to do this?

export GUROBI_HOME="/opt/gurobi1003/linux64"
export PATH="${PATH}:${GUROBI_HOME}/bin"
export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${GUROBI_HOME}/lib"

I think we only did this:

export GRB_LICENSE_FILE=/g/cba/software/ultrack/gurobi.lic

Is this the indicating that it is working? Using GRB solver

Could there be a simple python command to check whether the gurobi solver is present without running the whole tracking script?

JoOkuma commented 8 months ago

Hi Christian, Thanks for pointing this out, I’ll include this information to the README on the next few days.

JoOkuma commented 8 months ago

I almost forgot, a command “ultrack check_gurobi” is also a great idea. I’ll add that too.

JoOkuma commented 8 months ago

Yes, that means the gurobi solver is working.

Are you using conda? I'm under the impression it varies depending how you installed it. Conda must come with everything bundled and it only needs the license path.

tischi commented 8 months ago

Yes, using conda and it works with only the license.

In fact, these are our current instructions:

image

and it also works with the license only....

JoOkuma commented 8 months ago

If you use conda, can you avoid the wget step?

tischi commented 8 months ago

According to my above documentation, I use pip within conda, so not sure if that is what you mean by "using conda"?

And, oh, I see what you mean...somehow looking at my documentation I thought that the wget would download the license file, contained in the tar.gz, but I guess this is unlikely and I must have gotten the license file by some other means, i.e. my above documentation is wrong? Which could well be, because I got interrupted by the x-mas break finalising the documentation.

Anyway, I think very likely you are right and the wget step is superfluous, because the downloaded stuff is never used or referred to later...but then I need to add to the documentation how I actually got the license 😄