Skip to content

Commit

Permalink
update URLs after repo migration
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Jul 19, 2023
1 parent 756ea95 commit f3ca0dd
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The `<body>` will be used in the changelog (below).

### Changelog

See <https://github.com/paskino/qt-elements/releases>, or offline:
See <https://github.com/TomographicImaging/eqt/releases>, or offline:

```bash
git config --global alias.changelog 'for-each-ref --sort=-*authordate --format="# %(contents:subject)%0a%(contents:body)" refs/tags'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
cat <<EOF >> "$GITHUB_STEP_SUMMARY"
# Missing tag annotation
## Fix
See <https://github.com/paskino/qt-elements/tree/main/.github/workflows#releasing>.
See <https://github.com/TomographicImaging/eqt/tree/main/.github/workflows#releasing>.
## Suggested body
$changelog
EOF
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Copyright 2020 United Kingdom Research and Innovation (https://stfc.ukri.org)
Authors: https://github.com/paskino/qt-elements/graphs/contributors
Authors: https://github.com/TomographicImaging/eqt/graphs/contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ conda install eqt -c paskino
```

### Example
In the `example` directory there is an example on how to launch a `QDialog` with a form inside using `eqt`'s [`QWidget`](https://github.com/paskino/qt-elements/blob/main/examples/dialog_example.py) or [`FormDialog`](https://github.com/paskino/qt-elements/blob/main/examples/dialog_example_2.py).
In the `example` directory there is an example on how to launch a `QDialog` with a form inside using `eqt`'s [`QWidget`](https://github.com/TomographicImaging/eqt/blob/main/examples/dialog_example.py) or [`FormDialog`](https://github.com/TomographicImaging/eqt/blob/main/examples/dialog_example_2.py).

### Running asynchronous tasks
To run a function in a separate thread we use a `Worker` which is a subclass of a `QRunnable`.
Expand All @@ -35,7 +35,7 @@ For the `Worker` to work one needs to define:
1. the function that does what you need
2. Optional callback methods to get the status of the thread by means of `QtCore.QSignal`s

On [initialisation](https://github.com/paskino/qt-elements/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L32-L38) of the `Worker` the user needs to pass the function that has to run in the thread, i.e. `fn` below, and additional optional positional and keyword arguments, which will be passed on to the actual function that is run in the `QRunnable`.
On [initialisation](https://github.com/TomographicImaging/eqt/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L32-L38) of the `Worker` the user needs to pass the function that has to run in the thread, i.e. `fn` below, and additional optional positional and keyword arguments, which will be passed on to the actual function that is run in the `QRunnable`.

```python
class Worker(QtCore.QRunnable):
Expand All @@ -46,13 +46,13 @@ class Worker(QtCore.QRunnable):
self.signals = WorkerSignals()
```

In practice the user will need to pass to the `Worker` as many parameters as there are listed in the [function](https://github.com/paskino/qt-elements/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L56) to be run.
In practice the user will need to pass to the `Worker` as many parameters as there are listed in the [function](https://github.com/TomographicImaging/eqt/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L56) to be run.

```python
result = self.fn(*self.args, **self.kwargs)
```

But `Worker` will [add](https://github.com/paskino/qt-elements/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L41-L43) to the `**kwargs` the following `QSignal`.
But `Worker` will [add](https://github.com/TomographicImaging/eqt/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L41-L43) to the `**kwargs` the following `QSignal`.

```python
# Add progress callback to kwargs
Expand Down Expand Up @@ -87,7 +87,7 @@ worker.signals.progress.connect(handle_progress)
So, each time `fn` comes to `progress_callback.emit( i )` the function `handle_progress` will be called with the parameter `i` of its `for` loop.

#### What are the available signals?
The signals that are available in the `Worker` class are defined in [`WorkerSignal`](https://github.com/paskino/qt-elements/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L66) and are the following. Below you can also see the type of data that each signal can emit.
The signals that are available in the `Worker` class are defined in [`WorkerSignal`](https://github.com/TomographicImaging/eqt/blob/535e487d09d928713d7d6aa1123657597627c4b0/eqt/threading/QtThreading.py#L66) and are the following. Below you can also see the type of data that each signal can emit.
```python
finished = QtCore.Signal()
error = QtCore.Signal(tuple)
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ write_to_template = "__version__ = '{version}'\n"
exclude = ["test"]

[project.urls]
documentation = "https://github.com/paskino/qt-elements#readme"
repository = "https://github.com/paskino/qt-elements"
changelog = "https://github.com/paskino/qt-elements/releases"
documentation = "https://github.com/TomographicImaging/eqt#readme"
repository = "https://github.com/TomographicImaging/eqt"
changelog = "https://github.com/TomographicImaging/eqt/releases"

[project]
name = "eqt"
Expand Down

0 comments on commit f3ca0dd

Please sign in to comment.