Skip to content

Commit e95f5e5

Browse files
committed
Merge branch 'master' of github.com:scipopt/PySCIPOpt into fix-docs-version
2 parents 94815ee + be1c548 commit e95f5e5

File tree

8 files changed

+773
-12
lines changed

8 files changed

+773
-12
lines changed

.github/workflows/generate_docs.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Generate documentation
2+
3+
on:
4+
workflow_dispatch:
5+
inputs: {}
6+
7+
jobs:
8+
generate-documentation:
9+
runs-on: ubuntu-20.04
10+
steps:
11+
- uses: actions/checkout@v3
12+
13+
- name: Generate documentation
14+
run: |
15+
sudo apt-get install doxygen graphviz
16+
bash -ex generate-docs.sh "${{ secrets.GITHUB_TOKEN }}" "gh-pages"

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
### Added
55
- Created Statistics class
66
- Added parser to read .stats file
7+
- Release checklist in `RELEASE.md`
8+
- Added Python definitions and wrappers for SCIPstartStrongbranch, SCIPendStrongbranch SCIPgetBranchScoreMultiple,
9+
SCIPgetVarStrongbranchInt, SCIPupdateVarPseudocost, SCIPgetVarStrongbranchFrac, SCIPcolGetAge,
10+
SCIPgetVarStrongbranchLast, SCIPgetVarStrongbranchNode, SCIPallColsInLP, SCIPcolGetAge
11+
- Added getBipartiteGraphRepresentation
712
### Fixed
813
- Fixed too strict getObjVal, getVal check
914
### Changed

CONTRIBUTING.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,7 @@ If you find this contributing guide unclear, please open an issue! :)
4343
How to craft a release
4444
----------------------
4545

46-
1. update `CHANGELOG`
47-
2. increase version number in `src/pyscipopt/__init__.py` according to semantic versioning
48-
3. commit changes to the master branch
49-
3. tag new version `git tag vX.Y.Z`
50-
4. `git push` && `git push --tags`
51-
5. [create GitHub release](https://github.com/scipopt/PySCIPOpt/releases) based on that tag
52-
53-
A new PyPI package is automatically created by the GitHub actions when pushing a new tag onto the master and the version has been increased. Also the documentation is autmatically created in the process.
46+
Moved to [RELEASE.md](RELEASE.md).
5447

5548
Design principles of PySCIPOpt
5649
==============================

RELEASE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Release Checklist
2+
The following are the steps to follow to make a new PySCIPOpt release. They should mostly be done in order.
3+
- [ ] Check if [scipoptsuite-deploy](https://github.com/scipopt/scipoptsuite-deploy) needs a new release, if a new SCIP version is released for example, or new dependencies (change symmetry dependency, add support for papilo/ parallelization.. etc). And Update release links in `pyproject.toml`
4+
- [ ] Check if the table in [readme](https://github.com/scipopt/PySCIPOpt#installation) needs to be updated.
5+
- [ ] Update version number according to semantic versioning [rules](https://semver.org/) in `_version.py`
6+
- [ ] Update `CHANGELOG.md`; Change the `Unlreased` to the new version number and add an empty unreleased section.
7+
- [ ] Create a release candidate on test-pypi by running the workflow “Build wheels” in Actions->build wheels, with these parameters `upload:true, test-pypi:true` 
8+
- [ ] If the pipeline passes, test the released pip package on test-pypi by running and checking that it works
9+
```bash
10+
pip install -i https://test.pypi.org/simple/ PySCIPOpt
11+
```
12+
- [ ] If it works, release on pypi.org with running the same workflow but with `test-pypi:false`.
13+
- [ ] Then create a tag wit the new version (from the master branch)
14+
```bash
15+
git tag vX.X.X
16+
git push origin vX.X.X
17+
```
18+
- [ ] Then make a github [release](https://github.com/scipopt/PySCIPOpt/releases/new) from this new tag.
19+
- [ ] Update documentation by running the `Generate Docs` workflow in Actions->Generate Docs.

src/pyscipopt/scip.pxd

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -788,6 +788,7 @@ cdef extern from "scip/scip.h":
788788
int SCIPgetNLPCols(SCIP* scip)
789789
SCIP_COL** SCIPgetLPCols(SCIP *scip)
790790
SCIP_ROW** SCIPgetLPRows(SCIP *scip)
791+
SCIP_Bool SCIPallColsInLP(SCIP* scip)
791792

792793
# Cutting Plane Methods
793794
SCIP_RETCODE SCIPaddPoolCut(SCIP* scip, SCIP_ROW* row)
@@ -1258,7 +1259,15 @@ cdef extern from "scip/scip.h":
12581259
SCIP_RETCODE SCIPgetLPBranchCands(SCIP* scip, SCIP_VAR*** lpcands, SCIP_Real** lpcandssol,
12591260
SCIP_Real** lpcandsfrac, int* nlpcands, int* npriolpcands, int* nfracimplvars)
12601261
SCIP_RETCODE SCIPgetPseudoBranchCands(SCIP* scip, SCIP_VAR*** pseudocands, int* npseudocands, int* npriopseudocands)
1261-
1262+
SCIP_RETCODE SCIPstartStrongbranch(SCIP* scip, SCIP_Bool enablepropogation)
1263+
SCIP_RETCODE SCIPendStrongbranch(SCIP* scip)
1264+
SCIP_RETCODE SCIPgetVarStrongbranchLast(SCIP* scip, SCIP_VAR* var, SCIP_Real* down, SCIP_Real* up, SCIP_Bool* downvalid, SCIP_Bool* upvalid, SCIP_Real* solval, SCIP_Real* lpobjval)
1265+
SCIP_Longint SCIPgetVarStrongbranchNode(SCIP* scip, SCIP_VAR* var)
1266+
SCIP_Real SCIPgetBranchScoreMultiple(SCIP* scip, SCIP_VAR* var, int nchildren, SCIP_Real* gains)
1267+
SCIP_RETCODE SCIPgetVarStrongbranchWithPropagation(SCIP* scip, SCIP_VAR* var, SCIP_Real solval, SCIP_Real lpobjval, int itlim, int maxproprounds, SCIP_Real* down, SCIP_Real* up, SCIP_Bool* downvalid, SCIP_Bool* upvalid, SCIP_Longint* ndomredsdown, SCIP_Longint* ndomredsup, SCIP_Bool* downinf, SCIP_Bool* upinf, SCIP_Bool* downconflict, SCIP_Bool* upconflict, SCIP_Bool* lperror, SCIP_Real* newlbs, SCIP_Real* newubs)
1268+
SCIP_RETCODE SCIPgetVarStrongbranchInt(SCIP* scip, SCIP_VAR* var, int itlim, SCIP_Bool idempotent, SCIP_Real* down, SCIP_Real* up, SCIP_Bool* downvalid, SCIP_Bool* upvalid, SCIP_Bool* downinf, SCIP_Bool* upinf, SCIP_Bool* downconflict, SCIP_Bool* upconflict, SCIP_Bool* lperror)
1269+
SCIP_RETCODE SCIPupdateVarPseudocost(SCIP* scip, SCIP_VAR* var, SCIP_Real solvaldelta, SCIP_Real objdelta, SCIP_Real weight)
1270+
SCIP_RETCODE SCIPgetVarStrongbranchFrac(SCIP* scip, SCIP_VAR* var, int itlim, SCIP_Bool idempotent, SCIP_Real* down, SCIP_Real* up, SCIP_Bool* downvalid, SCIP_Bool* upvalid, SCIP_Bool* downinf, SCIP_Bool* upinf, SCIP_Bool* downconflict, SCIP_Bool* upconflict, SCIP_Bool* lperror)
12621271

12631272
# Numerical Methods
12641273
SCIP_Real SCIPinfinity(SCIP* scip)
@@ -1841,6 +1850,7 @@ cdef extern from "scip/pub_lp.h":
18411850
int SCIPcolGetNNonz(SCIP_COL* col)
18421851
SCIP_ROW** SCIPcolGetRows(SCIP_COL* col)
18431852
SCIP_Real* SCIPcolGetVals(SCIP_COL* col)
1853+
int SCIPcolGetAge(SCIP_COL* col)
18441854
int SCIPcolGetIndex(SCIP_COL* col)
18451855
SCIP_Real SCIPcolGetObj(SCIP_COL *col)
18461856

0 commit comments

Comments
 (0)