Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #5

Open
frankharkins opened this issue Jun 19, 2024 · 1 comment
Open

Improve README #5

frankharkins opened this issue Jun 19, 2024 · 1 comment

Comments

@frankharkins
Copy link

The following command fails and the error message suggests removing the .jl extension.

julia> Pkg.add("QiskitOpt.jl")

I'm not familiar with the Julia ecosystem, does it download this package from juliapackages.com? If so, it looks like the last update was a year ago so this command is probably installing an old version. If users should install from source, it wasn't clear to me as a non-Julia user.

I also noticed a small typo (IBQM).

export IBQM_API_TOKEN=YOUR_TOKEN_HERE
@pedroripper
Copy link
Member

Hi @frankharkins !

You are correct. The ".jl" and IBQM are typos. Thank you for pointing it out! I'll fix it right away.

The package is downloaded from JuliaRegistries

https://github.com/JuliaRegistries/General/tree/master/Q/QiskitOpt

There you can see that it is updated.

QiskitOpt is aimed for Julia's mathematical programming framework JuMP users.

So if you would like to use it, you first need to

  1. download Julia https://julialang.org/downloads/
  2. open Julia in your terminal and add JuMP and QiskitOpt with
using Pkg
Pkg.add("JuMP")
Pkg.add("QiskitOpt")

And then you should be able to run the code in the README.md file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants