Skip to content

Commit 103762f

Browse files
nwittlernwittler
authored
Merge pull request #3 from q-optimize/release/1.1
Release/1.1
2 parents 39e01b1 + 38eb765 commit 103762f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+5420
-5127
lines changed

‎.flake8‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[flake8]
2+
extend-ignore = E203, E266, E501, W503
23
max-line-length = 88
3-
ignore = E501,W503,E713,E203
4-
5-
6-
4+
max-complexity = 18
5+
select = B,C,E,F,W,T4,B9

‎.github/workflows/build_package.yml‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@ name: Python Package Build
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ master, dev, 'release/*' ]
66
pull_request:
7-
branches: [ master ]
7+
branches: [ master, dev, 'release/*' ]
8+
workflow_dispatch:
89

910
jobs:
1011
build:
1112
runs-on: ${{ matrix.os }}
1213
strategy:
1314
matrix:
14-
os: [ubuntu-20.04, ubuntu-18.04]
15+
os: [ubuntu-20.04, ubuntu-18.04, macos-latest, windows-latest]
1516
python-version: [3.6, 3.7, 3.8]
1617
env:
1718
OS: ${{ matrix.os }}
@@ -22,9 +23,6 @@ jobs:
2223
uses: actions/setup-python@v2
2324
with:
2425
python-version: ${{ matrix.python-version }}
25-
- name: Install packages
26-
run: |
27-
sudo apt-get install texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super gcc g++ python3-dev build-essential libboost-all-dev libopenblas-dev
2826
- name: Install c3 package
2927
run: |
3028
python -m pip install --upgrade pip

‎.github/workflows/complexity.yml‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ name: Code Complexity
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ master, dev, 'release/*' ]
66
pull_request:
7-
branches: [ master ]
7+
branches: [ master, dev, 'release/*' ]
8+
workflow_dispatch:
89

910
jobs:
1011
build:
@@ -22,19 +23,6 @@ jobs:
2223
uses: actions/setup-python@v2
2324
with:
2425
python-version: ${{ matrix.python-version }}
25-
- name: Install packages
26-
run: |
27-
sudo apt-get install texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super gcc g++ python3-dev build-essential libboost-all-dev libopenblas-dev
28-
- name: Cache pip
29-
uses: actions/cache@v2
30-
with:
31-
# This path is specific to Ubuntu
32-
path: ~/.cache/pip
33-
# Look to see if there is a cache hit for the corresponding requirements file
34-
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
35-
restore-keys: |
36-
${{ runner.os }}-pip-
37-
${{ runner.os }}-
3826
- name: Install dependencies
3927
run: |
4028
python -m pip install --upgrade pip

‎.github/workflows/coverage.yml‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ name: Code Coverage
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ master, dev, 'release/*' ]
66
pull_request:
7-
branches: [ master ]
7+
branches: [ master, dev, 'release/*' ]
8+
workflow_dispatch:
89

910
jobs:
1011
build:
@@ -22,19 +23,6 @@ jobs:
2223
uses: actions/setup-python@v2
2324
with:
2425
python-version: ${{ matrix.python-version }}
25-
- name: Install packages
26-
run: |
27-
sudo apt-get install texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super gcc g++ python3-dev build-essential libboost-all-dev libopenblas-dev
28-
- name: Cache pip
29-
uses: actions/cache@v2
30-
with:
31-
# This path is specific to Ubuntu
32-
path: ~/.cache/pip
33-
# Look to see if there is a cache hit for the corresponding requirements file
34-
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
35-
restore-keys: |
36-
${{ runner.os }}-pip-
37-
${{ runner.os }}-
3826
- name: Install dependencies
3927
run: |
4028
python -m pip install --upgrade pip

‎.github/workflows/integration_test.yml‎

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,27 @@ name: Integration Tests
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ master, dev, 'release/*' ]
66
pull_request:
7-
branches: [ master ]
7+
branches: [ master, dev, 'release/*' ]
8+
workflow_dispatch:
89

910
jobs:
1011
build:
11-
12-
runs-on: ubuntu-latest
12+
runs-on: ${{ matrix.os }}
1313
strategy:
1414
matrix:
15+
os: [ubuntu-20.04, ubuntu-18.04, macos-latest, windows-latest]
1516
python-version: [3.6, 3.7, 3.8]
16-
17+
env:
18+
OS: ${{ matrix.os }}
19+
PYTHON: ${{ matrix.python-version }}
1720
steps:
1821
- uses: actions/checkout@v2
1922
- name: Set up Python ${{ matrix.python-version }}
2023
uses: actions/setup-python@v2
2124
with:
2225
python-version: ${{ matrix.python-version }}
23-
- name: Install packages
24-
run: |
25-
sudo apt-get install texlive texlive-latex-extra texlive-fonts-recommended dvipng cm-super gcc g++ python3-dev build-essential libboost-all-dev libopenblas-dev
26-
- name: Cache pip
27-
uses: actions/cache@v2
28-
with:
29-
# This path is specific to Ubuntu
30-
path: ~/.cache/pip
31-
# Look to see if there is a cache hit for the corresponding requirements file
32-
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
33-
restore-keys: |
34-
${{ runner.os }}-pip-
35-
${{ runner.os }}-
3626
- name: Install dependencies
3727
run: |
3828
python -m pip install --upgrade pip

‎.github/workflows/publish_pypi.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- dev
8+
9+
jobs:
10+
build-and-publish:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@master
14+
- name: Set up Python 3.7
15+
uses: actions/setup-python@v1
16+
with:
17+
python-version: 3.7
18+
- name : Install Prerequisites
19+
run : |
20+
sudo apt-get install gcc libpq-dev -y
21+
sudo apt-get install python-dev python-pip -y
22+
sudo apt-get install python3-dev python3-pip python3-venv python3-wheel -y
23+
pip3 install wheel
24+
- name: Build sdist and bdist_wheel
25+
run: python setup.py sdist bdist_wheel
26+
- name: Publish distribution 📦 to Test PyPI
27+
uses: pypa/gh-action-pypi-publish@master
28+
with:
29+
password: ${{ secrets.test_pypi_password }}
30+
skip_existing: true
31+
repository_url: https://test.pypi.org/legacy/
32+
- name: Publish distribution 📦 to PyPI
33+
uses: pypa/gh-action-pypi-publish@master
34+
with:
35+
password: ${{ secrets.pypi_password }}
36+
skip_existing: true

‎MANIFEST.in‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include README.md

‎README.md‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
# C<sup>3</sup> - An integrated tool-set for Control, Calibration and Characterization
1+
# C3 - An integrated tool-set for Control, Calibration and Characterization
22

3-
The C<sup>3</sup> package is intended to close the loop between open-loop control optimization, control pulse calibration, and model-matching based on calibration data.
3+
[![codecov](https://codecov.io/gh/q-optimize/c3/branch/master/graph/badge.svg)](https://codecov.io/gh/q-optimize/c3)
4+
[![Documentation Status](https://readthedocs.org/projects/c3-toolset/badge/?version=latest)](https://c3-toolset.readthedocs.io/en/latest/?badge=latest)
5+
[![PyPI version fury.io](https://badge.fury.io/py/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
6+
[![PyPI license](https://img.shields.io/pypi/l/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
7+
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/c3-toolset.svg)](https://pypi.python.org/pypi/c3-toolset/)
48

5-
C<sup>3</sup> provides a simple Python API through which it may integrate with virtually any experimental setup.
9+
The C3 package is intended to close the loop between open-loop control optimization, control pulse calibration, and model-matching based on calibration data.
10+
11+
## Installation
12+
13+
```bash
14+
pip install c3-toolset
15+
```
16+
17+
C3 provides a simple Python API through which it may integrate with virtually any experimental setup.
618
Contact us at [[email protected]](mailto://[email protected]).
719

8-
The paper introducing C<sup>3</sup> as a concept can be found on the [arxiv](https://arxiv.org/abs/2009.09866).
20+
The paper introducing C3 as a concept can be found on the [arxiv](https://arxiv.org/abs/2009.09866).
921

1022
Documentation is available [here](https://c3-toolset.readthedocs.io).
1123

12-
github is at [https://github.com/q-optimize/c3](https://github.com/q-optimize/c3).
24+
The source code is available on Github at [https://github.com/q-optimize/c3](https://github.com/q-optimize/c3).

0 commit comments

Comments
 (0)