diff --git a/.github/workflows/directory_writer.yml b/.github/workflows/directory_writer.yml index d164300..25b80e8 100644 --- a/.github/workflows/directory_writer.yml +++ b/.github/workflows/directory_writer.yml @@ -7,7 +7,7 @@ on: pull_request: push: branches: - - "master" + - "main" jobs: Update_DIRECTORY: diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index 7bf067d..924b13c 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -5,13 +5,13 @@ name: Tests on: push: - branches: [master] + branches: [main] paths-ignore: - "doc/**" - "gh-disabled-workflows/**" - "*.md" pull_request: - branches: [master] + branches: [main] paths-ignore: - "doc/**" - "gh-disabled-workflows/**" diff --git a/CHANGELOG.md b/CHANGELOG.md index 4cdcde4..13dd0a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -98,7 +98,7 @@ See [#47] - Added the possibility to specify and create multiple graph-visualizations in one file [#25] - Added test case _test_vc_multiple_and_join_ in [commit aa31901](https://github.com/VaeterchenFrost/tdvisu/commit/aa319016ac71f9a54023474bf820cb30929c52a8) -- Added test cases for [construct_dpdb_visu](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_construct_dpdb.py) +- Added test cases for [construct_dpdb_visu](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_construct_dpdb.py) - Add pytest-mock to tests_require ### Changed @@ -275,9 +275,9 @@ See [#47] [@VaeterchenFrost]: https://github.com/VaeterchenFrost [PyPI]: https://pypi.org/project/tdvisu/ [mypy]: https://github.com/python/mypy -[DIRECTORY]: https://github.com/VaeterchenFrost/tdvisu/blob/master/DIRECTORY.md +[DIRECTORY]: https://github.com/VaeterchenFrost/tdvisu/blob/main/DIRECTORY.md [Codecov]: https://codecov.io/gh/VaeterchenFrost/tdvisu -[Unreleased]: https://github.com/VaeterchenFrost/tdvisu/compare/v1.2.0...master +[Unreleased]: https://github.com/VaeterchenFrost/tdvisu/compare/v1.2.0...main [1.2.0]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.2.0 [1.1.9]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.9 [1.1.8]: https://github.com/VaeterchenFrost/tdvisu/releases/tag/v1.1.8 diff --git a/DIRECTORY.md b/DIRECTORY.md index 7b0ee6b..21a73ee 100644 --- a/DIRECTORY.md +++ b/DIRECTORY.md @@ -1,22 +1,22 @@ -## [Setup](https://github.com/VaeterchenFrost/tdvisu/blob/master/setup.py) +## [Setup](https://github.com/VaeterchenFrost/tdvisu/blob/main/setup.py) ## Tdvisu - * [Construct Dpdb Visu](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/construct_dpdb_visu.py) - * [Dijkstra](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/dijkstra.py) - * [Reader](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/reader.py) - * [Svgjoin](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/svgjoin.py) - * [Utilities](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/utilities.py) - * [Version](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/version.py) - * [Visualization](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/visualization.py) - * [Visualization Data](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/visualization_data.py) + * [Construct Dpdb Visu](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/construct_dpdb_visu.py) + * [Dijkstra](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/dijkstra.py) + * [Reader](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/reader.py) + * [Svgjoin](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/svgjoin.py) + * [Utilities](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/utilities.py) + * [Version](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/version.py) + * [Visualization](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/visualization.py) + * [Visualization Data](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/visualization_data.py) ## Test - * [Test Bag Creation](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_bag_creation.py) - * [Test Construct Dpdb](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_construct_dpdb.py) - * [Test Dijkstra](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_dijkstra.py) - * [Test Reader](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_reader.py) - * [Test Svgjoin](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_svgjoin.py) - * [Test Utilities](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_utilities.py) - * [Test Version](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_version.py) - * [Test Visualization](https://github.com/VaeterchenFrost/tdvisu/blob/master/test/test_visualization.py) + * [Test Bag Creation](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_bag_creation.py) + * [Test Construct Dpdb](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_construct_dpdb.py) + * [Test Dijkstra](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_dijkstra.py) + * [Test Reader](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_reader.py) + * [Test Svgjoin](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_svgjoin.py) + * [Test Utilities](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_utilities.py) + * [Test Version](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_version.py) + * [Test Visualization](https://github.com/VaeterchenFrost/tdvisu/blob/main/test/test_visualization.py) diff --git a/README.md b/README.md index 2f724ef..5af862c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg) [![PyPI license](https://img.shields.io/pypi/l/tdvisu.svg)](https://pypi.python.org/pypi/tdvisu/) ![Tests](https://github.com/VaeterchenFrost/tdvisu/workflows/Tests/badge.svg) -[![codecov](https://codecov.io/gh/VaeterchenFrost/tdvisu/branch/master/graph/badge.svg)](https://codecov.io/gh/VaeterchenFrost/tdvisu) +[![codecov](https://codecov.io/gh/VaeterchenFrost/tdvisu/branch/main/graph/badge.svg)](https://codecov.io/gh/VaeterchenFrost/tdvisu) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/vaeterchenfrost/tdvisu?include_prereleases) [![PyPI version fury.io](https://badge.fury.io/py/tdvisu.svg)](https://pypi.python.org/pypi/tdvisu/) @@ -132,11 +132,11 @@ pytest ./test/ # How to use -The visualization needs input in the form of the [Json API](https://github.com/VaeterchenFrost/gpusat-VISU/blob/master/JsonAPI_v1.3.md). +The visualization needs input in the form of the [Json API](https://github.com/VaeterchenFrost/gpusat-VISU/blob/main/JsonAPI_v1.3.md). The creation of this file is exemplary implemented in _construct_dpdb_visu.py_ or the fork [GPUSAT](https://github.com/VaeterchenFrost/GPUSAT) and _--visufile filename_ (optionally disabling preprocessing with _-p_). Run the python file with the above dependencies installed: -[visualization.py](https://github.com/VaeterchenFrost/gpusat-VISU/blob/master/satvisualization_repo/satvisu/visualization.py) +[visualization.py](https://github.com/VaeterchenFrost/gpusat-VISU/blob/main/satvisualization_repo/satvisu/visualization.py) **visualization.py** takes two parameters, the json-**infile** to read from, and optionally one **outputfolder**. With both arguments a run might look like this: @@ -153,13 +153,13 @@ For #SAT it produces for example three different graphs suffixed with a running The graphs are images encoded in resolution independent **.svg files** (see https://www.lifewire.com/svg-file-4120603) -

+

## How to use construct_dpdb_visu.py After installing the project [dp_on_dbs](https://github.com/hmarkus/dp_on_dbs) with the there listed [requirements](https://github.com/hmarkus/dp_on_dbs#requirements), we need to -- edit the [database.ini](https://github.com/VaeterchenFrost/tdvisu/blob/master/tdvisu/database.ini) with our password to [postgresql](https://www.postgresql.org/) +- edit the [database.ini](https://github.com/VaeterchenFrost/tdvisu/blob/main/tdvisu/database.ini) with our password to [postgresql](https://www.postgresql.org/) - Solve a problem with `python dpdb.py [GENERAL-OPTIONS] -f [PROBLEM-SPECIFIC-OPTIONS]` - for the problem **VertexCover** - with flag `--gr-file` to store the htd Input (if the input was in a different format) @@ -206,7 +206,7 @@ In case dependencies have changed, or just to update some, check ## Push -- Push changes to master +- Push changes to main - Wait for all automated checks! (All checks have passed...) ## Create Release @@ -219,7 +219,7 @@ In case dependencies have changed, or just to update some, check ## Should automatically release to [PyPI](https://pypi.org/project/tdvisu/) -- For details see: [Upload Python Package](https://github.com/VaeterchenFrost/tdvisu/blob/master/.github/workflows/python-publish.yml) +- For details see: [Upload Python Package](https://github.com/VaeterchenFrost/tdvisu/blob/main/.github/workflows/python-publish.yml) **Now you are set for the new release :tada:** diff --git a/TDVisu.schema.json b/TDVisu.schema.json index 4596105..2e0bef0 100644 --- a/TDVisu.schema.json +++ b/TDVisu.schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "$id": "https://raw.githubusercontent.com/VaeterchenFrost/tdvisu/master/TDVisu.schema.json", + "$id": "https://raw.githubusercontent.com/VaeterchenFrost/tdvisu/main/TDVisu.schema.json", "type": "object", "title": "The root schema for TDVisu", "description": "The schema describes the valid JSON input for visualizing dynamic programming on tree-decompositions in TDVisu.", diff --git a/scripts/build_directory_md.py b/scripts/build_directory_md.py index 562bd4c..042e857 100644 --- a/scripts/build_directory_md.py +++ b/scripts/build_directory_md.py @@ -30,7 +30,7 @@ from typing import Iterator from urllib.parse import quote -URL_BASE = "https://github.com/VaeterchenFrost/tdvisu/blob/master" +URL_BASE = "https://github.com/VaeterchenFrost/tdvisu/blob/main" AFFECTED_EXT = ( ".py",