Skip to content

Commit

Permalink
Added docs Badge and referred to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ckoerber committed Nov 8, 2021
1 parent a18bb4e commit 5033fc5
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![Documentation Status](https://readthedocs.org/projects/lsqfitgui/badge/?version=latest)](https://lsqfitgui.readthedocs.io/en/latest/?badge=latest)
# Lsqfit GUI

Graphical user interface for `lsqfit` using `dash`.
Expand All @@ -6,9 +7,10 @@ Graphical user interface for `lsqfit` using `dash`.

## Install

Run
Run the following commands in the repository root directory
```
pip install [-e] .
pip install --upgrade numpy scipy
pip install [--user] [-e] .
```

## Usage
Expand Down Expand Up @@ -44,14 +46,7 @@ lsqfitgui [--function other_script.py:fcn] fit.p

Both commands will spawn a local server hosting the lsqfit interface.

## Advanced configuration

It is possible to also set up fit meta information, i.e., allowing different fit models. See also the `example` directory for more details.

The following script spawns the server which generated the above image
```bash
python example/entrypoint.py
```
For more information, see also [the documentation](https://lsqfitgui.readthedocs.io/en/latest/).


## Tests
Expand Down

0 comments on commit 5033fc5

Please sign in to comment.