Skip to content

Commit

Permalink
botch readme to be accepted by pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
Jhsmit committed Sep 4, 2024
1 parent 45c28f9 commit c77caef
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ streams:
AD: [laser_A, det_D]
```

> [!IMPORTANT]
> The notation used here is excitation then emission, thus the FRET stream is 'DA' while in literature the FRET photon stream is often written as `A|D` (Acceptor emission during donor excitation).
!IMPORTANT
The notation used here is excitation then emission, thus the FRET stream is 'DA' while in literature the FRET photon stream is often written as `A|D` (Acceptor emission during donor excitation).


> [!IMPORTANT]
> At the moment apparent FRET and stoichiometry are calculated from the defined photon streams and it is required the following streams are defined: 'AA', 'DD', 'DA' (=FRET). This is expected to be changed in future updates.
!IMPORTANT
At the moment apparent FRET and stoichiometry are calculated from the defined photon streams and it is required the following streams are defined: 'AA', 'DD', 'DA' (=FRET). This is expected to be changed in future updates.

## Development

Expand All @@ -94,3 +94,8 @@ wget https://kuleuven-my.sharepoint.com/:u:/g/personal/jochem_smit_kuleuven_be/E

If autoreload (refresh web application upon code changes) doesnt work, run from:
solara run dont_fret\tmp.py -- --config default_testing.yaml

### Create a new release

- Create a new release on github
- github actions creates release on pypi

0 comments on commit c77caef

Please sign in to comment.