Skip to content

Commit 3e76d02

Browse files
authored
Update repository URLs (again) (#199)
* Update URLs and name: PEtabGUI -> PEtabGUI * Fix screenshot URL
1 parent 3c144b5 commit 3e76d02

6 files changed

Lines changed: 24 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
[![PyPI - Version](https://badge.fury.io/py/PEtab-GUI.svg)](https://pypi.org/project/PEtab-GUI/)
22
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15355753.svg)](https://doi.org/10.5281/zenodo.15355753)
33

4-
# PEtabGUI
4+
# PEtab-GUI
55

6-
PEtabGUI provides a graphical user interface to inspect and edit parameter
6+
PEtab-GUI provides a graphical user interface to inspect and edit parameter
77
estimation problems encoded in the
88
[PEtab](https://petab.readthedocs.io/en/latest/#) format.
99

1010
## Installation
1111

1212
### From PyPI
1313

14-
To install PEtabGUI from [PyPI](https://pypi.org/project/PEtab-GUI/), run:
14+
To install PEtab-GUI from [PyPI](https://pypi.org/project/PEtab-GUI/), run:
1515

1616
```bash
1717
pip install petab_gui
1818
```
1919

20-
or, to install PEtabGUI in a dedicated virtual environment using
20+
or, to install PEtab-GUI in a dedicated virtual environment using
2121
[pipx](https://github.com/pypa/pipx) (to be installed separately), run:
2222

2323
```bash
@@ -29,15 +29,15 @@ pipx install petab_gui
2929
To install the latest development version from GitHub, run:
3030

3131
```bash
32-
pip install git+https://github.com/PEtab-dev/PEtabGUI/
32+
pip install git+https://github.com/PEtab-dev/PEtab-GUI/
3333
```
3434

3535
### From a local copy
3636

3737
1. Clone the repository:
3838

3939
```bash
40-
git clone https://github.com/PEtab-dev/PEtabGUI.git
40+
git clone https://github.com/PEtab-dev/PEtab-GUI.git
4141
```
4242

4343
2. Install the package from the root of the working tree:
@@ -48,14 +48,14 @@ pip install git+https://github.com/PEtab-dev/PEtabGUI/
4848

4949
## Usage
5050

51-
After installation, launch PEtabGUI from the command line using the
51+
After installation, launch PEtab-GUI from the command line using the
5252
`petab_gui` command.
5353

5454
Optionally, you can provide the path to an existing PEtab YAML file
5555
as an argument.
5656

57-
After loading a PEtab problem, PEtabGUI will look something like this:
58-
![PEtabGUI Screenshot](https://raw.githubusercontent.com/PEtab-dev/PEtabGUI/screenshot/docs/source/_static/Application_Screenshot.png)
57+
After loading a PEtab problem, PEtab-GUI will look something like this:
58+
![PEtab-GUI Screenshot](https://raw.githubusercontent.com/PEtab-dev/PEtab-GUI/main/docs/source/_static/Application_Screenshot.png)
5959

6060
### Examples
6161

@@ -64,13 +64,13 @@ A set of real-world PEtab problems is available in the
6464

6565
Download and unpack the [archive](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab/archive/refs/heads/master.zip),
6666
then open one of the YAML files inside `Benchmark-Models/*/` using
67-
PEtabGUI.
67+
PEtab-GUI.
6868
`Benchmark-Models/Boehm_JProteomeRes2014/Boehm_JProteomeRes2014.yaml`
6969
should serve as a good starting point.
7070

7171
## Features
7272

73-
The PEtabGUI provides a Python-based graphical user interface that simplifies
73+
The PEtab-GUI provides a Python-based graphical user interface that simplifies
7474
the creation, editing, and validation of PEtab parameter estimation problems.
7575

7676
- **Unified Environment**

docs/source/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Filing an Issue
4242
----------------
4343

4444
If you encounter any bugs or have feature requests, please file an issue on GitHub.
45-
`Open a new issue <https://github.com/PEtab-dev/PEtabGUI/issues/new/choose>`__.
45+
`Open a new issue <https://github.com/PEtab-dev/PEtab-GUI/issues/new/choose>`__.
4646

4747
When filing an issue, provide as much detail as possible,
4848
including steps to reproduce the issue, expected behavior, and any relevant logs or screenshots.

docs/source/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ PEtab GUI - A graphical user interface for PEtab
2323
Quick Links
2424
-----------
2525

26-
* `GitHub Repository <https://github.com/PEtab-dev/PEtabGUI>`_
27-
* `Issue Tracker <https://github.com/PEtab-dev/PEtabGUI/issues>`_
26+
* `GitHub Repository <https://github.com/PEtab-dev/PEtab-GUI>`_
27+
* `Issue Tracker <https://github.com/PEtab-dev/PEtab-GUI/issues>`_
2828
* `PEtab Documentation <https://petab.readthedocs.io/en/latest/>`_
2929

3030
Overview
@@ -54,5 +54,5 @@ To get started with PEtab GUI, check out the :doc:`installation instructions <re
5454
:maxdepth: 1
5555
:caption: Development
5656

57-
GitHub Repository <https://github.com/PEtab-dev/PEtabGUI>
57+
GitHub Repository <https://github.com/PEtab-dev/PEtab-GUI>
5858
contributing

docs/source/tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Alternatively, you can install it from the GitHub repository by following these
3232

3333
.. code-block:: bash
3434
35-
git clone https://github.com/PEtab-dev/PEtabGUI.git
35+
git clone https://github.com/PEtab-dev/PEtab-GUI.git
3636
3737
2. Install using pip:
3838

src/petab_gui/C.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
import numpy as np
44

55
#: Application name
6-
APP_NAME = "PEtabGUI"
6+
APP_NAME = "PEtab-GUI"
77
#: Base URL of the repository
8-
REPO_URL = "https://github.com/PEtab-dev/PEtabGUI"
8+
REPO_URL = "https://github.com/PEtab-dev/PEtab-GUI"
9+
#: Base URL of the documentation
10+
DOCS_URL = "https://petab-gui.readthedocs.io/en/latest/"
911

1012
COLUMNS = {
1113
"measurement": {

src/petab_gui/controllers/logger_controller.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
from datetime import datetime
44

5+
from ..C import APP_NAME, DOCS_URL
6+
57

68
class LoggerController:
79
"""Mainly responsible for handling the logger widget."""
@@ -16,11 +18,11 @@ def __init__(self, views):
1618
"""
1719
self.views = views
1820
self.logger_level = 1
19-
self.log_message("Welcome to PEtabGUI!", color="green")
21+
self.log_message(f"Welcome to {APP_NAME}!", color="green")
2022
self.log_message(
2123
"If you need help, click <b>Help</b> in the menu,"
2224
" enter the Help Mode (click question mark in toolbar) or visit "
23-
'the <a href="https://petab-gui.readthedocs.io/en/latest/" '
25+
f'the <a href="{DOCS_URL}" '
2426
'style="color:blue;" target="_blank">documentation</a>.',
2527
color="green",
2628
)

0 commit comments

Comments
 (0)