Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,38 @@

A pyglotaran based jupyter notebook widget for teaching parameter estimation examples. It can simulate data, visualize it and create related model.yml, parameters.csv and dataset.nc files. It is supposed to help students learn about the basics of the pyglotaran ecosystem.

## Usage

### Option 1: Run directly from GitHub with uv

Install and run PyParamGUI directly from the repository without cloning:

```bash
uv run --with "pyparamgui @ git+https://github.com/glotaran/PyParamGUI" --with jupyter jupyter lab
```
Comment thread
s-weigand marked this conversation as resolved.

### Option 2: Run from a local clone

Clone the repository and run with the local source:

```bash
uv run --with . --with jupyter jupyter lab
```

### Option 3: Add to an existing uv project

Add PyParamGUI as a dependency to your project:

```bash
uv add pyparamgui @ git+https://github.com/glotaran/PyParamGUI
Comment thread
s-weigand marked this conversation as resolved.
Outdated
```

Then run Jupyter Lab in your project environment:

```bash
uv run jupyter lab
```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down
1 change: 0 additions & 1 deletion pyparamgui/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
__all__ = ["Widget"]
"""
Package Usage:
%env ANYWIDGET_HMR=1
from pyparamgui import Widget

widget = Widget()
Expand Down
Loading
Loading