Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobwilliams committed Oct 17, 2022
1 parent 252ed29 commit 627ba0c
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,33 @@ The library can be built with the [Fortran Package Manager](https://github.com/f
fpm build --release
```

By default, the library is built with double precision (`real64`) real values. Explicitly specifying the real kind can be done using the following processor flags:

Preprocessor flag | Kind | Number of bytes
----------------- | ----- | ---------------
`REAL32` | `real(kind=real32)` | 4
`REAL64` | `real(kind=real64)` | 8
`REAL128` | `real(kind=real128)` | 16

For example, to build a single precision version of the library, use:

```
fpm build --profile release --flag "-DREAL32"
```

To use SLSQP within your fpm project, add the following to your `fpm.toml` file:

```yml
```toml
[dependencies]
slsqp = { git="https://github.com/jacobwilliams/slsqp.git" }
```

or, to use a specific version:
```toml
[dependencies]
slsqp = { git="https://github.com/jacobwilliams/slsqp.git", tag = "1.2.3" }
```

### Development

* Development continues on [GitHub](https://github.com/jacobwilliams/slsqp).
Expand All @@ -60,7 +80,7 @@ slsqp = { git="https://github.com/jacobwilliams/slsqp.git" }
### References

* [Original sourcecode at NETLIB](http://www.netlib.org/toms/733)
* D. Kraft, "[A software package for sequential quadratic programming](http://degenerateconic.com/wp-content/uploads/2018/03/DFVLR_FB_88_28.pdf)",
* D. Kraft, "[A software package for sequential quadratic programming](https://degenerateconic.com/uploads/2018/03/DFVLR_FB_88_28.pdf)",
Technical Report DFVLR-FB 88-28, Institut für Dynamik der Flugsysteme,
Oberpfaffenhofen, July 1988.
* D. Kraft, "[Algorithm 733: TOMP--Fortran modules for optimal control calculations](http://dl.acm.org/citation.cfm?id=192124),"
Expand Down

0 comments on commit 627ba0c

Please sign in to comment.