Skip to content

Commit

Permalink
Propagate the from-source scip-sys feature (#135)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmghannam authored Mar 30, 2024
1 parent 9c4b555 commit eafc61b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ exclude = ["data/test/*"]
[features]
raw = []
bundled = ["scip-sys/bundled"]
from-source = ["scip-sys/from-source"]

[dependencies]
scip-sys = "0.1.9"
scip-sys = "0.1.11"

[dev-dependencies]
rayon = "1.5.1"
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,24 @@ A safe Rust interface for [SCIP](https://www.scipopt.org/index.php#download). Th
The project is currently actively developed, issues/pull-requests are very welcome.

## Installation

By running
```bash
cargo add russcip --features bundled
```
or to get the most recent version, add the following to your `Cargo.toml`
```toml
[dependencies]
russcip = { git = "https://github.com/scipopt/russcip", features = ["bundled"] }
```

The `bundled` feature will download a precompiled SCIP as part of the build process.
This is the easiest to get started with russcip, if you want to use a custom SCIP installation check the [section](#custom-scip-installation) below.
This is the easiest to get started with russcip, instead you could try the [from-source](#from-source-feature)
or if you want to link against your custom SCIP installation check the [section](#custom-scip-installation) below.

### `from-source` feature
To build SCIP from source, you can enable the `from-source` feature. This will download the SCIP source code and build it as part of the build process.
```bash
cargo add russcip --features from-source
```

## Custom SCIP installation
If the `bundled` feature is not enabled, `russcip` will look for a scip installation in the current conda environment,
### Custom SCIP installation
If no feature is not enabled, `russcip` will look for a scip installation in the current conda environment,
to install SCIP using conda run the following command
```bash
conda install --channel conda-forge scip
Expand Down

0 comments on commit eafc61b

Please sign in to comment.