Skip to content

Commit

Permalink
shell
Browse files Browse the repository at this point in the history
  • Loading branch information
galabovaa committed Jun 10, 2024
1 parent 4a6a95e commit 3f56011
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ Documentation is available at https://ergo-code.github.io/HiGHS/.

HiGHS uses CMake as build system, and requires at least version 3.15. To generate build files in a new subdirectory called 'build', run:

```sh
```shell
cmake -S . -B build
cmake --build build
```
This installs the executable `bin/highs` and the library `lib/highs`.

To test whether the compilation was successful, change into the build directory and run

```sh
```shell
ctest
```
More details on building with CMake can be found in `HiGHS/cmake/README.md`.
Expand Down Expand Up @@ -134,7 +134,7 @@ See https://ergo-code.github.io/HiGHS/stable/installation/#Precompiled-Binaries.
HiGHS can read MPS files and (CPLEX) LP files, and the following command
solves the model in `ml.mps`

```sh
```shell
highs ml.mps
```
#### Command line options
Expand Down Expand Up @@ -181,13 +181,13 @@ We are happy to give a reasonable level of support via email sent to highsopt@gm

The python package `highspy` is a thin wrapper around HiGHS and is available on [PyPi](https://pypi.org/project/highspy/). It can be easily installed via `pip` by running

```sh
```shell
$ pip install highspy
```

Alternatively, `highspy` can be built from source. Download the HiGHS source code and run

```sh
```shell
pip install .
```
from the root directory.
Expand All @@ -207,7 +207,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget

It can be added to your C# project with `dotnet`

```bash
```shell
dotnet add package Highs.Native --version 1.7.0
```

Expand Down
14 changes: 7 additions & 7 deletions cmake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,26 +123,26 @@ cmake --install build

By default, CMake builds the debug version of the binaries. These are generated in a directory `Debug`. To build a release version, add the option `--config Release`

```bash
```shell
cmake -S . -B build
cmake --build build --config Release
```

It is also possible to specify a specific Visual studio version to build with:
```bash
```shell
cmake -G "Visual Studio 17 2022" -S . -B build
cmake --build build
```

When building under Windows, some extra options are available. One is building a 32 bit version or a 64 bit version. The default build is 64 bit. To build 32 bit, the following commands can be used from the `HiGHS/` directory:

```bash
```shell
cmake -A Win32 -S . -B buildWin32
cmake --build buildWin32
```

Another thing specific for windows is the calling convention, particularly important for the HiGHS dynamic library (dll). The default calling convention in windows is cdecl calling convention, however, dlls are most often compiled with stdcall. Most applications which expect stdcall, can't access dlls with cdecl and vice versa. To change the default calling convention from cdecl to stdcall the following option can be added
```bash
```shell
cmake -DSTDCALL=ON -S . -B build
cmake --build build
```
Expand All @@ -163,12 +163,12 @@ before running `cmake --build <your_chosen_build_directory>`<br>
For example, to generate build files in a new
subdirectory called 'build', run:

```sh
```shell
cmake -S. -Bbuild
```
and then build with:

```sh
```shell
cmake --build build
```

Expand All @@ -187,7 +187,7 @@ Following is a list of available options:

<!-- Following is a list of available options, for the full list run:
```sh
```shell
cmake -S. -Bbuild -LH
``` -->

Expand Down
4 changes: 2 additions & 2 deletions docs/src/executable.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For convenience, the executable is assumed to be `bin/highs`.

The model given by the MPS file `model.mps` is solved by the command:

```bash
```shell
$ bin/highs model.mps
```

Expand All @@ -19,7 +19,7 @@ When HiGHS is run from the command line, some fundamental option values may be
specified directly. Many more may be specified via a file. Formally, the usage
is:

```bash
```shell
$ bin/highs --help
HiGHS options
Usage:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/interfaces/csharp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget

It can be added to your C# project with `dotnet`

```bash
```shell
dotnet add package Highs.Native --version 1.7.0
```

Expand Down
2 changes: 1 addition & 1 deletion docs/src/interfaces/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ HiGHS is available as `highspy` on [PyPi](https://pypi.org/project/highspy/).

If `highspy` is not already installed, run:

```bash
```shell
$ pip install highspy
```

Expand Down
2 changes: 1 addition & 1 deletion docs/src/options/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ options file.
A sample options file, giving documentation of all the options is written to the
console by the command:

```bash
```shell
$ bin/highs --options_file=""
```

Expand Down
4 changes: 2 additions & 2 deletions nuget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The nuget package Highs.Native is on https://www.nuget.org, at https://www.nuget

It can be added to your C# project with `dotnet`

```bash
```shell
dotnet add package Highs.Native --version 1.7.0
```

Expand All @@ -29,7 +29,7 @@ cmake -S. -Bbuild -DCSHARP=ON -DBUILD_DOTNET=ON

Then, from `build/dotnet/Highs.Native`, run

```bash
```shell
dotnet pack -c Release /p:Version=$version
```

Expand Down

0 comments on commit 3f56011

Please sign in to comment.