CUTEst

Julia's CUTEst Interface

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

Science Score: 64.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 15 committers (6.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

cutest julia julia-language nlpmodels optimization

Keywords from Contributors

factorization krylov performance-profile linear-systems permutations nonlinear-programming ampl amd optimization-tools optimization-algorithms
Last synced: 4 months ago · JSON representation ·

Repository

Julia's CUTEst Interface

Basic Info
  • Host: GitHub
  • Owner: JuliaSmoothOptimizers
  • License: other
  • Language: Julia
  • Default Branch: main
  • Size: 3.27 MB
Statistics
  • Stars: 59
  • Watchers: 6
  • Forks: 21
  • Open Issues: 8
  • Releases: 0
Topics
cutest julia julia-language nlpmodels optimization
Created almost 11 years ago · Last pushed 5 months ago
Metadata Files
Readme License Citation Zenodo

README.md

CUTEst.jl: Julia's CUTEst Interface

This package provides an interface to CUTEst, a repository of constrained and unconstrained nonlinear programming problems for testing and comparing optimization algorithms, derived from the abstract model on NLPModels.jl.

Stable release Github release DOI

  • Documentation: docs-stable
  • Chat: Gitter

Development version

  • Documentation: docs-dev
  • Tests: build-gh codecov
  • Downloads: downloads

How to Cite

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

Installing

This package will automatically install the CUTEst binaries for your platform. The gfortran compiler is required to compile decoded SIF problems. Users on all platforms except Windows must install it to use CUTEst.jl. For Windows users, a small artifact containing gfortran.exe is installed automatically. No other Fortran compiler is supported.

The following command installs the CUTEst binaries and the Julia interface:

julia pkg> add CUTEst

Usage

After installation, you can create instances of NLPModels models using the CUTEstModel constructor:

```julia using CUTEst

nlp = CUTEstModel{Float64}("BYRDSPHR") ```

This model supports the same functions as other NLPModels, for example:

```julia using NLPModels

fx = obj(nlp, nlp.meta.x0) gx = grad(nlp, nlp.meta.x0) Hx = hess(nlp, nlp.meta.x0)

cx = cons(nlp, nlp.meta.x0) Jx = jac(nlp, nlp.meta.x0) ```

Problems can also be instantiated in single and quadruple precision:

```julia using CUTEst, Quadmath

nlpsingle = CUTEstModel{Float32}("BYRDSPHR") nlpquadruple = CUTEstModel{Float128}("BYRDSPHR") ```

To retrieve the list of available SIF problems, use the function list_sif_problems:

```julia using CUTEst

availableproblems = listsif_problems() ```

If you want to retrieve only problems with specific properties, you can use the function select_sif_problems:

```julia using CUTEst

filteredproblems = selectsifproblems(; minvar=10, maxvar=100, onlylinear_con=true) ```

Tutorial

You can check an Introduction to CUTEst.jl on our site.

Related Packages

GPLv3

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: 'CUTEst.jl: Julia''s CUTEst interface'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Alexis
    family-names: Montoison
    email: alexis.montoison@polymtl.ca
    orcid: "https://orcid.org/0000-0002-3403-5450"
    affiliation: "GERAD and Department of Mathematics and Industrial Engineering, Polytechnique Montréal, QC, Canada."
  - given-names: Dominique
    family-names: Orban
    email: dominique.orban@gerad.ca
    affiliation: >-
      GERAD and Department of Mathematics and            
      Industrial Engineering, Polytechnique
      Montréal, QC, Canada
    orcid: 'https://orcid.org/0000-0002-8017-7687'
  - given-names: Abel
    family-names: Soares Siqueira
    orcid: 'https://orcid.org/0000-0003-4451-281X'
    affiliation: 'Netherlands eScience Center, Amsterdam, NL'
    email: abel.s.siqueira@gmail.com
  - given-names: contributors
identifiers:
  - type: doi
    value: 10.5281/zenodo.1188851
repository-code: 'https://github.com/JuliaSmoothOptimizers/CUTEst.jl'
keywords:
  - CUTEst
  - Optimization
  - Julia
version: 1.0.0
date-released: '2024-08-29'

GitHub Events

Total
  • Create event: 26
  • Commit comment event: 18
  • Release event: 9
  • Issues event: 17
  • Watch event: 9
  • Delete event: 14
  • Issue comment event: 62
  • Push event: 98
  • Pull request review comment event: 18
  • Pull request review event: 17
  • Pull request event: 63
Last Year
  • Create event: 26
  • Commit comment event: 18
  • Release event: 9
  • Issues event: 17
  • Watch event: 9
  • Delete event: 14
  • Issue comment event: 62
  • Push event: 98
  • Pull request review comment event: 18
  • Pull request review event: 17
  • Pull request event: 63

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 526
  • Total Committers: 15
  • Avg Commits per committer: 35.067
  • Development Distribution Score (DDS): 0.58
Past Year
  • Commits: 149
  • Committers: 6
  • Avg Commits per committer: 24.833
  • Development Distribution Score (DDS): 0.101
Top Committers
Name Email Commits
Abel Soares Siqueira a****a@g****m 221
Alexis Montoison a****n@p****a 144
Dominique Orban d****n@g****m 107
tmigot t****t@g****m 22
github-actions[bot] 4****] 12
Sungho Shin s****n@a****v 5
Tim Holy t****y@g****m 4
Asbjørn Nilsen Riseth a****h@g****m 3
Xx-Alexis-xX a****n@e****r 2
JSOBot 6****t 1
Jay-sanjay 1****y 1
Julia TagBot 5****t 1
MaxenceGollier 1****r 1
Monssaf Toukal t****f@g****m 1
Nicolas Lepage-Saucier 4****S 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 52
  • Total pull requests: 220
  • Average time to close issues: about 1 year
  • Average time to close pull requests: about 1 month
  • Total issue authors: 22
  • Total pull request authors: 12
  • Average comments per issue: 3.31
  • Average comments per pull request: 1.45
  • Merged pull requests: 183
  • Bot issues: 0
  • Bot pull requests: 47
Past Year
  • Issues: 9
  • Pull requests: 64
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 12 hours
  • Issue authors: 6
  • Pull request authors: 4
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.94
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 10
Top Authors
Issue Authors
  • amontoison (12)
  • tmigot (7)
  • abelsiqueira (6)
  • dpo (4)
  • senna1128 (3)
  • mahaa2 (2)
  • NicolasL-S (2)
  • MaxenceGollier (2)
  • vepiteski (2)
  • leonardosecchin (2)
  • sshin23 (1)
  • FengYiLiao (1)
  • JuliaTagBot (1)
  • hddmaelle (1)
  • aldma (1)
Pull Request Authors
  • amontoison (151)
  • github-actions[bot] (73)
  • dpo (26)
  • tmigot (21)
  • abelsiqueira (21)
  • arnavk23 (8)
  • JSOBot (3)
  • MaxenceGollier (2)
  • sshin23 (2)
  • NicolasL-S (1)
  • Jay-sanjay (1)
  • JuliaTagBot (1)
Top Labels
Issue Labels
enhancement (16) documentation (5) tests (3) bug (2) good first issue (2) help wanted (2) build system (1) SIF (1)
Pull Request Labels
formatting (64) automated pr (64) no changelog (64) epic (2) enhancement (1) build system (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 31 total
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 36
juliahub.com: CUTEst

Julia's CUTEst Interface

  • Versions: 36
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 31 Total
Rankings
Forks count: 7.5%
Dependent repos count: 7.7%
Average: 14.0%
Stargazers count: 16.8%
Dependent packages count: 24.0%
Last synced: 5 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia v1 composite
.github/workflows/Documentation.yml actions
  • actions/checkout v3 composite
  • julia-actions/setup-julia latest composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • Homebrew/actions/setup-homebrew master composite
  • actions/cache v3 composite
  • 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/format_pr.yml actions
  • actions/checkout v2 composite
  • peter-evans/create-pull-request v3 composite