Skip to content

Commit

Permalink
Generalize Transformation API (#349)
Browse files Browse the repository at this point in the history
* initial changes

* More progress

* completed tests and naming

* Updated Docs

* project updates

* fix tests

* fix/debug docs

* remove checkdocs
  • Loading branch information
pulsipher authored Jul 3, 2024
1 parent 6e1102d commit cc34cc5
Show file tree
Hide file tree
Showing 84 changed files with 4,643 additions and 4,278 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "InfiniteOpt"
uuid = "20393b10-9daf-11e9-18c9-8db751c92c57"
authors = ["Joshua Pulsipher and Weiqi Zhang"]
version = "0.5.8"
version = "0.5.9"

[deps]
DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ interface for these advanced problem types that can be used by those with little
to no background in these areas. It also it contains a wealth of capabilities
making it a powerful and convenient tool for advanced users.

:tada: **`v0.5` introduces general nonlinear modeling!**: See the documentation for details.

:mega: **`v0.5.1` now requires Julia 1.6 or newer**

**Current Version:** [![](https://docs.juliahub.com/InfiniteOpt/version.svg)](https://juliahub.com/ui/Packages/InfiniteOpt/p3GvY) [![](https://docs.juliahub.com/InfiniteOpt/pkgeval.svg)](https://juliahub.com/ui/Packages/InfiniteOpt/p3GvY)

| **Documentation** | **Build Status** | **Citation** |
Expand All @@ -27,7 +23,6 @@ include:
- Infinite variables (decision functions) (e.g., `y(t, x)`)
- Derivatives (e.g., `∂y(t, x)/∂t`)
- Measures (e.g., `∫y(t,x)dt`, `𝔼[y(ξ)]`)
- **1st class nonlinear modeling**

The unifying modeling abstraction behind `InfiniteOpt` captures a wide spectrum
of disciplines which include dynamic, PDE, stochastic, and semi-infinite
Expand All @@ -48,7 +43,7 @@ can be installed by entering the following in the REPL.
```julia
julia> ]

(v1.9) pkg> add InfiniteOpt
(v1.10) pkg> add InfiniteOpt
```

## Documentation
Expand Down Expand Up @@ -83,7 +78,7 @@ citing it.
A pre-print version is freely available though [arXiv](https://arxiv.org/abs/2106.12689).

## Project Status
The package is tested against Julia `1.6` and `1.9` on Linux, Mac, and Windows.
The package is tested against Julia `1.6` and `1.10` on Linux, Mac, and Windows.

## Contributing
`InfiniteOpt` is being actively developed and suggestions or other forms of contribution are encouraged.
Expand Down
8 changes: 4 additions & 4 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"

[compat]
Distributions = "0.25"
Documenter = "0.27"
Documenter = "1.5"
InfiniteOpt = "0.5"
Ipopt = "1.4"
Ipopt = "1.6"
HiGHS = "1"
julia = "1.6"
JuMP = "1.15"
Literate = "2.14"
JuMP = "1.22"
Literate = "2.18"
Plots = "1"
SpecialFunctions = "2"
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ To install it, run the following command in a Julia session:
```julia
julia> ]

(v1.8) pkg> add Documenter
(v1.10) pkg> add Documenter
```

You'll also need to make sure you have `JuMP.jl`, `Distributions.jl`, and `Ipopt.jl`
Expand Down
1 change: 0 additions & 1 deletion docs/jump/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ include:
- Infinite variables (decision functions) (for example, ``y(t, x)``)
- Derivatives (for example, ``\frac{\partial y(t, x)}{\partial t}``)
- Measures (for example, ``\int_{t \in T}y(t, x)dt`` and ``\mathbb{E}[y(\xi)]``)
- First class nonlinear modeling

The unifying modeling abstraction behind `InfiniteOpt` captures a wide spectrum
of disciplines which include dynamic, PDE, stochastic, and semi-infinite
Expand Down
19 changes: 10 additions & 9 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using Documenter, InfiniteOpt, Distributions, Literate, Random
using Documenter, InfiniteOpt, Distributions, Literate, Random, Pkg

if !@isdefined(EXAMPLE_DIR)
const EXAMPLE_DIR = joinpath(@__DIR__, "src", "examples")
Expand Down Expand Up @@ -84,8 +84,8 @@ makedocs(;
"Measures" => "manual/measure.md",
"Objectives" => "manual/objective.md",
"Constraints" => "manual/constraint.md",
"Model Transcription" => "manual/transcribe.md",
"Optimization" => "manual/optimize.md",
"Backends" => "manual/backend.md",
"TranscriptionOpt" => "manual/transcribe.md",
"Results" => "manual/result.md"
],
"Development" => [
Expand All @@ -94,21 +94,22 @@ makedocs(;
"Style Guide" => "develop/style.md"
],
],
repo = "https://github.com/infiniteopt/InfiniteOpt.jl/blob/{commit}{path}#L{line}",
# repo = "https://github.com/infiniteopt/InfiniteOpt.jl/blob/{commit}{path}#L{line}",
sitename = "InfiniteOpt.jl",
authors = "Joshua Pulsipher and Weiqi Zhang",
doctest = true,
checkdocs = :exports,
modules = [InfiniteOpt],
checkdocs = :none,
linkcheck = true,
linkcheck_ignore = [r"https://www.youtube.com/.*"],
strict = true,
linkcheck_ignore = [r"https://www.youtube.com/.*", "https://github.com/infiniteopt/InfiniteOpt.jl/blob/master/test/extensions/backend.jl"], # TODO remove before merging
# warnonly = true,
format = Documenter.HTML(
# See https://github.com/JuliaDocs/Documenter.jl/issues/868
prettyurls = get(ENV, "CI", nothing) == "true",
analytics = "UA-178297470-1",
collapselevel = 1,
assets = ["assets/extra_styles.css"],

size_threshold = 250 * 2^10, # KiB
size_threshold_warn = 150 * 2^10 # KiB
)
)

Expand Down
Loading

0 comments on commit cc34cc5

Please sign in to comment.