diff --git a/README.md b/README.md index f8b6986..a01f15a 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,12 @@ <br> </div> -## Introduction - -This package provides a wrapper around [QUBOLibData.jl](https://github.com/pedromxavier/QUBOLibData.jl)'s artifact to easily access QUBO / Ising instances. -Instances are retrieved as model objects from [QUBOTools.jl](https://github.com/psrenergy/QUBOTools.jl). - ## Getting Started ### Installation ```julia -julia> import Pkg; Pkg.add(url="https://github.com/pedromxavier/QUBOLib.jl") +julia> import Pkg; Pkg.add(url="https://github.com/JuliaQUBO/QUBOLib.jl") julia> using QUBOLib ``` @@ -25,11 +20,11 @@ julia> using QUBOLib ### Example ```julia -julia> coll = first(list_collections()) # get code of the first registered collection - -julia> inst = first(list_instances(coll)) # get code of the first instance from that collection +julia> using QUBOLib -julia> model = load_instance(coll, inst) # retrieve QUBOTools model +julia> QUBOLib.access() do index + println(index) + end ``` ## Accessing the instance index database @@ -37,19 +32,17 @@ julia> model = load_instance(coll, inst) # retrieve QUBOTools model > **Warning** > This requires [SQLite.jl](https://github.com/JuliaDatabases/SQLite.jl) and [DataFrames.jl](https://github.com/JuliaData/DataFrames.jl) to be installed. - ```julia -julia> using SQLite, DataFrames +julia> using QUBOLib -julia> db = QUBOLib.database() +julia> using SQLite, DataFrames -julia> df = DBInterface.execute( - db, - "SELECT collection, instance FROM instances WHERE size BETWEEN 100 AND 200;" - ) |> DataFrame +julia> models = QUBOLib.access() do index + df = DBInterface.execute( + QUBOLib.database(index), + "SELECT instance FROM Instances WHERE size BETWEEN 100 AND 200;" + ) |> DataFrame -julia> models = [ - load_instance(coll, inst) - for (coll, inst) in zip(df[!, :collection], df[!, :instance]) - ] + return [load_instance(index, i) for i in df[!, :instance]] + end ```