Data

Tools

Indexes

Applications

Experiments

Open Source Science

cvx-package-template

Python package template for cvxpy extensions.

https://github.com/langestefan/cvx-package-template

Science Score: 44.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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Python package template for cvxpy extensions.

Basic Info
  • Host: GitHub
  • Owner: langestefan
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 1.75 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 11 months ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

cvx-package-template

build docs codecov license pypi

Template instructions (to be removed)

This is a template for creating packages in the cvxpy ecosystem. It provides a basic structure and configuration for a Python package, including:

  • A pyproject.toml file for package metadata and dependencies.
  • A tests directory for unit tests using pytest and pytest-cov for coverage reporting.
  • A docs directory for documentation using Sphinx.
  • A examples directory for example usage of the package, which will be displayed in the documentation.
  • Linting and formatting using ruff and typechecking using ty.
  • Pre-commit hooks using pre-commit to ensure code quality before committing changes.

Running tests

To be able to run unit tests with uv you will need:

bash uv sync --group dev

You can then run the tests using:

bash uv run pytest tests

Alternatively, with pip you can install the dev dependencies and run the tests using:

bash pip install -e .[dev] pytest tests

Building documentation locally

To build and run the documentation locally using sphinx-autobuild, you need to first install dependencies using the following commands:

bash uv sync --group dev --group doc uv run sphinx-autobuild docs/src docs/_build/html

Alternatively, with pip you can install the dev and doc dependencies and run the documentation using:

bash pip install -e .[dev,doc] sphinx-autobuild docs/src docs/_build/html

Repository description goes here.

The full documentation is available here.

If you wish to cite repository please cite the papers listed here.

Owner

  • Name: Stefan de Lange
  • Login: langestefan
  • Kind: user
  • Location: Eindhoven

Electrical Engineer. I work on mathematical engineering, modelling and machine learning topics within the energy transition.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Newton
    given-names: Isaac
    orcid: https://orcid.org/1234-5678-9101-1121
title: "My Research Software"
version: 2.0.4
identifiers:
  - type: doi
    value: 10.5281/zenodo.1234
date-released: 2021-08-11

GitHub Events

Total
  • Push event: 31
  • Pull request event: 1
  • Create event: 2
Last Year
  • Push event: 31
  • Pull request event: 1
  • Create event: 2

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 359 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
pypi.org: cvx-package-template

CVX package template for convex optimization projects.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 359 Last month
Rankings
Dependent packages count: 8.7%
Average: 29.0%
Dependent repos count: 49.2%
Maintainers (1)
langestefan
Last synced: 10 months ago

Dependencies

.github/workflows/docs.yml actions
  • JamesIves/github-pages-deploy-action v4.7.3 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
pyproject.toml pypi