Initial commit

.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.9-bookworm",
+	"onCreateCommand": ".devcontainer/startup.sh",
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"python.testing.pytestEnabled": true,
+				"python.testing.unittestEnabled": false,
+				"python.testing.pytestArgs": [
+					"."
+				],
+				"python.pythonPath": ".venv/bin/python",
+				"python.defaultInterpreterPath": ".venv/bin/python",
+				"python.terminal.activateEnvInCurrentTerminal": true
+			},
+			"extensions": [
+				"ms-toolsai.jupyter"
+			]
+		}
+	}
+}

.devcontainer/startup.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+pipx install poetry
+poetry config virtualenvs.in-project true
+poetry install
+poetry run pre-commit install

.github/workflows/basic.yml

@@ -0,0 +1,13 @@
+name: "basic"
+
+on:
+  push:
+
+jobs:
+  basic:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: pre-commit/action@v3.0.0
+    - uses: cvxgrp/.github/actions/test@main

.github/workflows/book.yml

@@ -0,0 +1,62 @@
+name: "book"
+
+on:
+  push:
+    branches:
+      - main
+
+
+jobs:
+  sphinx:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cvxgrp/.github/actions/sphinx@main
+
+  test:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cvxgrp/.github/actions/test@main
+
+  jupyter:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cvxgrp/.github/actions/jupyter@main
+        with:
+          kernel: "cvxsimulator"
+
+  book:
+    runs-on: "ubuntu-latest"
+    needs: [test, sphinx, jupyter]
+
+    permissions:
+      contents: write
+
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Download Book
+        uses: actions/download-artifact@v3
+        with:
+          name: book
+          path: .book
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: sphinx
+          path: .book/artifacts/sphinx
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: tests
+          path: .book/artifacts/tests
+
+      - name: GitHub Pages action
+        uses: JamesIves/github-pages-deploy-action@v4.4.3
+        with:
+          branch: gh-pages          # The branch the action should deploy to.
+          folder: .book              # The folder the action should deploy.

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: "ci"
+
+on:
+  push
+
+jobs:
+  test:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        python-version: ['3.8', '3.9', '3.10', '3.11' ]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+
+      - uses: cvxgrp/.github/actions/test@main
+        with:
+          os: ${{ matrix.os }}
+          python-version: ${{ matrix.python-version }}
+
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2

.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+
+    permissions:
+      # This permission is required for trusted publishing.
+      id-token: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cvxgrp/.github/actions/release@main

.gitignore

@@ -0,0 +1,164 @@
+.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache
+.ruff_cache
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+#htmlcov/
+#.tox/
+#.nox/
+.coverage
+#.coverage.*
+#.cache
+#nosetests.xml
+#coverage.xml
+# *.cover
+# *.py,cover
+# .hypothesis/
+# .pytest_cache/
+# cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-toml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: fix-encoding-pragma
+
+-   repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+    -   id: black
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: 'v0.0.275'
+  hooks:
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.35.0
+  hooks:
+  - id: markdownlint-fix
+    args: ["--ignore", "book/**/*.md"]
+
+
+- repo: 'https://github.com/pre-commit/mirrors-mypy'
+  rev: v1.4.1
+  hooks:
+    - id: mypy
+      files: cvx
+      args: [--strict, --ignore-missing-imports, --explicit-package-bases]