CaNNOLeS

Constrained and NoNlinear Optimizer of Least Squares

https://github.com/juliasmoothoptimizers/cannoles.jl

Science Score: 57.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
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords from Contributors

ipopt nlpmodels nonlinear-programming mathematical-programming krylov performance-profile mathematical-optimization jso sparse-matrix sparse-matrices
Last synced: 7 months ago · JSON representation ·

Repository

Constrained and NoNlinear Optimizer of Least Squares

Basic Info
  • Host: GitHub
  • Owner: JuliaSmoothOptimizers
  • License: other
  • Language: Julia
  • Default Branch: main
  • Size: 3.05 MB
Statistics
  • Stars: 23
  • Watchers: 4
  • Forks: 6
  • Open Issues: 4
  • Releases: 21
Created about 7 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

CaNNOLeS - Constrained and NoNlinear Optimizer of Least Squares

documentation documentation CI Cirrus CI - Base Branch Build Status codecov GitHub

CaNNOLeS is a solver for equality-constrained nonlinear least-squares problems, i.e., optimization problems of the form

min ¹/₂‖F(x)‖²      s. to     c(x) = 0.

It uses other JuliaSmoothOptimizers packages for development. In particular, NLPModels.jl is used for defining the problem, and SolverCore for the output. It also uses HSL.jl's MA57 as main solver, but you can pass linsolve=:ldlfactorizations to use LDLFactorizations.jl.

References

Orban, D., & Siqueira, A. S. A Regularization Method for Constrained Nonlinear Least Squares. Computational Optimization and Applications 76, 961–989 (2020). 10.1007/s10589-020-00201-2

If you use CaNNOLeS.jl in your work, please cite using the format given in CITATION.cff.

Installation

  1. Follow HSL.jl's MA57 installation if possible. Otherwise LDLFactorizations.jl will be used.
  2. pkg> add CaNNOLeS

Examples

```julia using CaNNOLeS, ADNLPModels

Rosenbrock

nls = ADNLSModel(x -> [x[1] - 1; 10 * (x[2] - x[1]^2)], [-1.2; 1.0], 2) stats = cannoles(nls)

Constrained

nls = ADNLSModel( x -> [x[1] - 1; 10 * (x[2] - x[1]^2)], [-1.2; 1.0], 2, x -> [x[1] * x[2] - 1], [0.0], [0.0], ) stats = cannoles(nls) ```

Bug reports and discussions

If you think you found a bug, feel free to open an issue. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

If you want to ask a question not suited for a bug report, feel free to start a discussion here. This forum is for general discussion about this repository and the JuliaSmoothOptimizers, so questions about any of our packages are welcome.

Owner

  • Name: JuliaSmoothOptimizers
  • Login: JuliaSmoothOptimizers
  • Kind: organization
  • Location: DOI: 10.5281/zenodo.2655082

Infrastructure and Solvers for Continuous Optimization in Julia

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  CaNNOLeS.jl: Constrained and NoNlinear Optimizer of Least Squares
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Tangi
    family-names: Migot
    email: tangi.migot@gmail.com
    affiliation: >-
      GERAD and Department of Mathematics and
      Industrial Engineering, Polytechnique Montréal,
      QC, Canada.
    orcid: 'https://orcid.org/0000-0001-7729-2513'
  - given-names: Dominique
    family-names: Orban
    email: dominique.orban@gerad.ca
    orcid: 'https://orcid.org/0000-0002-8017-7687'
    affiliation: >-
      GERAD and Department of Mathematics and
      Industrial Engineering, Polytechnique Montréal,
      QC, Canada
  - affiliation: 'Netherlands eScience Center, Amsterdam, NL'
    orcid: 'https://orcid.org/0000-0003-4451-281X'
    email: abel.s.siqueira@gmail.com
    given-names: Abel
    family-names: Soares Siqueira
  - given-names: contributors
identifiers:
  - description: Zenodo archive
    type: doi
    value: 10.5281/zenodo.4154524
preferred-citation:
  type: article
  authors:
  - family-names: "Orban"
    given-names: "Dominique"
    orcid: "https://orcid.org/0000-0002-8017-7687"
  - family-names: "Soares Siqueira"
    given-names: "Abel"
    orcid: "https://orcid.org/0000-0003-4451-281X"
  doi: "10.1007/s10589-020-00201-2"
  journal: "Computational Optimization and Applications"
  month: 6
  start: 961 # First page number
  title: "A regularization method for constrained nonlinear least squares"
  issue: 3
  volume: 76
  year: 2020
keywords:
  - Nonlinear Optimization
  - Least squares
  - Julia
  - Nonlinear Programming
license: MPL-2.0
repository-code: >-
  https://github.com/JuliaSmoothOptimizers/CaNNOLeS.jl

GitHub Events

Total
  • Create event: 7
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 3
  • Watch event: 2
  • Delete event: 7
  • Issue comment event: 3
  • Push event: 27
  • Pull request review event: 3
  • Pull request review comment event: 3
  • Pull request event: 13
Last Year
  • Create event: 7
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 3
  • Watch event: 2
  • Delete event: 7
  • Issue comment event: 3
  • Push event: 27
  • Pull request review event: 3
  • Pull request review comment event: 3
  • Pull request event: 13

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 125
  • Total Committers: 12
  • Avg Commits per committer: 10.417
  • Development Distribution Score (DDS): 0.544
Top Committers
Name Email Commits
tmigot t****t@g****m 57
Abel Soares Siqueira a****a@g****m 34
JSOBot 6****t@u****m 8
github-actions[bot] 4****]@u****m 7
Alexis Montoison a****n@p****a 5
Dominique Orban d****n@g****m 4
Monssaf Toukal t****f@g****m 3
tmigot t****t@u****m 3
Julia TagBot 5****t@u****m 1
abelsiqueira a****a@u****m 1
dpo d****o@u****m 1
CompatHelper Julia c****y@j****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 15
  • Total pull requests: 102
  • Average time to close issues: 6 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 1.93
  • Average comments per pull request: 0.9
  • Merged pull requests: 88
  • Bot issues: 0
  • Bot pull requests: 24
Past Year
  • Issues: 1
  • Pull requests: 7
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 7 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.29
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • tmigot (12)
  • amontoison (1)
  • JuliaTagBot (1)
  • abelsiqueira (1)
Pull Request Authors
  • tmigot (76)
  • github-actions[bot] (26)
  • abelsiqueira (6)
  • amontoison (5)
  • dpo (1)
Top Labels
Issue Labels
good first issue (2) enhancement (2) documentation (2) question (1)
Pull Request Labels
formatting (14) automated pr (14) no changelog (14) documentation (7) bug (4) help wanted (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 1 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 21
juliahub.com: CaNNOLeS

Constrained and NoNlinear Optimizer of Least Squares

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1 Total
Rankings
Dependent repos count: 9.9%
Forks count: 19.4%
Average: 24.3%
Stargazers count: 29.1%
Dependent packages count: 38.9%
Last synced: 7 months ago

Dependencies

.github/workflows/Aqua.yml actions
  • actions/checkout v3 composite
  • julia-actions/setup-julia latest composite
.github/workflows/CI_M1.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 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
.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/Documentation.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia latest composite
.github/workflows/Invalidations.yml actions
  • actions/checkout v3 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-invalidations v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • 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
.github/workflows/format_pr.yml actions
  • actions/checkout v2 composite
  • peter-evans/create-pull-request v3 composite
.github/workflows/CI_Linux.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 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
.github/workflows/Breakage.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v2 composite
  • thollander/actions-comment-pull-request v2 composite