Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.8%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Julia interface to the NOMAD blackbox optimization software
Basic Info
Statistics
- Stars: 47
- Watchers: 8
- Forks: 7
- Open Issues: 15
- Releases: 14
Topics
Metadata Files
README.md
NOMAD.jl
| Documentation | Build Status | Coverage | DOI |
|:-----------------:|:----------------:|:------------:|:-------:|
| 
| 
| 
| 
|
This package provides a Julia interface for NOMAD, which is a C++ implementation of the Mesh Adaptive Direct Search algorithm (MADS), designed for difficult blackbox optimization problems. These problems occur when the functions defining the objective and constraints are the result of costly computer simulations.
How to Cite
If you use NOMAD.jl in your work, please cite using the format given in CITATION.bib.
Installation
NOMAD can be installed and tested through the Julia package manager:
julia
julia> ]
pkg> add NOMAD
pkg> test NOMAD
Quick start
Let's say you want to minimize some objective function :
julia
function f(x)
return x[1]^2 + x[2]^2
end
while keeping some constraint inferior to 0 :
julia
function c(x)
return 1 - x[1]
end
You first need to declare a function eval_fct(x::Vector{Float64}) that returns a Vector{Float64} containing the objective function and the constraint evaluated for x, along with two booleans.
julia
function eval_fct(x)
bb_outputs = [f(x), c(x)]
success = true
count_eval = true
return (success, count_eval, bb_outputs)
end
success is a boolean set to false if the evaluation should not be taken into account by NOMAD. Here, every evaluation will be considered as a success. count_eval is also a boolean, it decides weather the evaluation's counter will be incremented. Here, it is always equal to true so every evaluation will be counted.
Then, create an object of type NomadProblem that will contain settings for the optimization.
The classic constructor takes as arguments the initial point x0 and the types of the outputs contained in bb_outputs (as a Vector{String}).
julia
pb = NomadProblem(2, # number of inputs of the blackbox
2, # number of outputs of the blackbox
["OBJ", "EB"], # type of outputs of the blackbox
eval_fct;
lower_bound=[-5.0, -5.0],
upper_bound=[5.0, 5.0])
Here, first element of bb_outputs is the objective function (f(x)), second is a constraint treated with the Extreme Barrier method (c(x)). In this example, lower and upper bounds have been added but it is not compulsory.
Now call the function solve(p::NomadProblem, x0::Vector{Float64}) where x0 is the initial starting point to launch a NOMAD optimization process.
julia
result = solve(pb, [3.0, 3.0])
The object returned by solve() contains information about the run.
Custom Installation
Note: NOMAD is already precompiled with Yggdrasil for all platforms.
To use your custom NOMAD, set the environmental variables JULIA_NOMAD_LIBRARY_PATH
to point the shared library. Note that NOMAD version 4.3.1 is needed.
For example:
julia
ENV["JULIA_NOMAD_LIBRARY_PATH"] = "~/Applications/nomad-4.3.1/build/lib"
using NOMAD
Alternatively, you can create an entry in .julia/config/startup.jl or set these permanently through your operating system.
Citation (CITATION.bib)
@Misc{montoison-pascal-salomon-nomad-2020,
author = {A. Montoison and P. Pascal and L. Salomon},
title = {{NOMAD.jl}: A {J}ulia interface for the constrained blackbox solver {NOMAD}},
month = {July},
howpublished = {\url{https://github.com/bbopt/NOMAD.jl}},
year = {2020},
DOI = {10.5281/zenodo.3700167},
}
GitHub Events
Total
- Create event: 1
- Commit comment event: 2
- Issues event: 2
- Release event: 1
- Watch event: 2
- Member event: 1
- Issue comment event: 12
- Push event: 9
- Pull request review event: 1
- Pull request review comment event: 2
- Pull request event: 3
- Fork event: 1
Last Year
- Create event: 1
- Commit comment event: 2
- Issues event: 2
- Release event: 1
- Watch event: 2
- Member event: 1
- Issue comment event: 12
- Push event: 9
- Pull request review event: 1
- Pull request review comment event: 2
- Pull request event: 3
- Fork event: 1
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 237
- Total Committers: 8
- Avg Commits per committer: 29.625
- Development Distribution Score (DDS): 0.7
Top Committers
| Name | Commits | |
|---|---|---|
| ppascal97 | 4****7@u****m | 71 |
| ppascal97 | p****l@m****r | 70 |
| Alexis Montoison | a****n@p****a | 47 |
| salomonl | l****n@g****a | 43 |
| tmigot | t****t@g****m | 2 |
| Sobhan Mohammadpour | s****r@u****a | 2 |
| Alexis | 3****n@u****m | 1 |
| CompatHelper Julia | c****y@j****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 29
- Total pull requests: 50
- Average time to close issues: 5 months
- Average time to close pull requests: 20 days
- Total issue authors: 13
- Total pull request authors: 8
- Average comments per issue: 4.07
- Average comments per pull request: 1.2
- Merged pull requests: 42
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 3
- Pull requests: 3
- Average time to close issues: 2 days
- Average time to close pull requests: 10 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 1.67
- Average comments per pull request: 3.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- amontoison (11)
- tmigot (3)
- MonssafToukal (3)
- sivabkumar (3)
- ufechner7 (2)
- simonp0420 (1)
- ValentinKaisermayer (1)
- stumarcus314 (1)
- shoshievass (1)
- ko56 (1)
- sblelong (1)
- dpo (1)
- JuliaTagBot (1)
- martinmestre (1)
Pull Request Authors
- amontoison (33)
- salomonl (8)
- github-actions[bot] (4)
- SobhanMP (2)
- jrwrigh (2)
- golanor (2)
- tmigot (1)
- ppascal97 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 30 total
- Total dependent packages: 3
- Total dependent repositories: 0
- Total versions: 15
juliahub.com: NOMAD
Julia interface to the NOMAD blackbox optimization software
- Documentation: https://docs.juliahub.com/General/NOMAD/stable/
- License: MPL-2.0
-
Latest release: 2.4.2
published 7 months ago
Rankings
Dependencies
- julia-actions/setup-julia latest composite
- actions/checkout v2 composite
- julia-actions/setup-julia latest composite
- JuliaRegistries/TagBot v1 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- codecov/codecov-action v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite