Skip to content

Commit

Permalink
Add Shrinkwrap License Agreement (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
@odow
odow authored Mar 12, 2024
1 parent 38830af commit 9c30ad5
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,54 @@
by FICO Xpress. If you are a commercial customer interested in official support
for Julia from FICO Xpress, let them know.

## Installation

Install `Xpress_jll` using `Pkg.add`:
```julia
import Pkg
Pkg.add("Xpress_jll")
```

In addition to installing the `Xpress_jll.jl` package, this command will also
download and install the Xpress binaries. You do not need to install Xpress
separately.

## License

`Xpress_jll.jl` is licensed under the [MIT License](https://github.com/odow/Xpress_jll.jl/blob/master/LICENSE.md).
The Julia source code in `Xpress_jll.jl` is licensed under the
[MIT License](https://github.com/odow/Xpress_jll.jl/blob/master/LICENSE.md).

The Xpress artifacts that are automatically downloaded on install are governed
by the [Xpress Shrinkwrap License Agreement](https://community.fico.com/s/contentdocument/06980000002h0i5AAA).
When installing `Xpress_jll`, you accept the shrinkwrap license terms.

A copy of the Xpress Shrinkwrap License is stored in the file `LICENSE.txt` in
the dist-info directory of the installed artifact.

Use `Xpress_jll.print_shinkwrap_license()` to display the contents:
```julia
julia> import Xpress_jll

julia> Xpress_jll.print_shrinkwrap_license()
Shrinkwrap License Agreement
FICO(tm) Xpress Optimization Suite
FICO(tm) Xpress Insight
... lines omitted ...
```

The underlying solver is a closed-source commercial product for which you must
[purchase a license](https://www.fico.com/products/fico-xpress-solver).

`Xpress_jll.jl` includes the community license of Xpress, see the
[licensing options overview](https://community.fico.com/s/fico-xpress-optimization-licensing-optio)
for more details.

## Platforms

`Xpress_jll.jl` is available for the following platforms:

* `macOS x86_64` (`x86_64-apple-darwin`)
* `macOS aarch64` (`aarch64-apple-darwin`)
* `Linux x86_64` (`x86_64-linux-gnu`)
* `Windows x86_64` (`x86_64-w64-mingw32`)

Expand Down
14 changes: 14 additions & 0 deletions src/Xpress_jll.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,18 @@ import JLLWrappers
JLLWrappers.@generate_main_file_header("Xpress")
JLLWrappers.@generate_main_file("Xpress", UUID("308bddfa-7f95-4fa6-a557-f2c7addc1869"))

"""
print_shrinkwrap_license(io = stdout)
Print the Shrinkwrap License Agreement that governs the usage of the Xpress
artifacts.
"""
function print_shrinkwrap_license(io = stdout)
license = joinpath(artifact_dir, "info", "licenses", "LICENSE.txt")
print(io, read(license, String))
return
end

export print_shrinkwrap_license

end # module Xpress_jll
6 changes: 6 additions & 0 deletions test/runtests.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,9 @@ end
@test unsafe_string(p) == "42.01.05"
end
end

@testset "print_shrinkwrap_license" begin
contents = sprint(print_shrinkwrap_license)
@test occursin("Shrinkwrap", contents)
@test length(contents) > 1_000
end

2 comments on commit 9c30ad5

@odow
Copy link
Member Author

@odow odow commented on 9c30ad5 Mar 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/103121

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v9.3.0 -m "<description of version>" 9c30ad5c378960e34b87d40481303bab95a7555b
git push origin v9.3.0

Also, note the warning: This looks like a new registration that registers version 9.3.0.
Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.