Skip to content

Commit 8663241

Browse files
committed
Update README.md
1 parent 34b7717 commit 8663241

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# tttrconvert
22

3-
A ``tttrconvert`` is a tool to convert time-tagged time-resolved files into different formats. ``tttrconvert`` to read
3+
A ``tttrconvert`` is a very basic tool to convert time-tagged time-resolved files into different formats. ``tttrconvert`` to read
44
and write TTTR files ``tttrconvert`` uses ``tttrlib``. The tool ``tttrconvert`` can be embedded
55
in other software and is part of ChiSurf.
66

7+
Currently, the tool has only very basic functions (it is probably not
8+
what you want).
9+
710
![tttrconvert GUI][1]
811

912
## Building and installation
@@ -15,7 +18,7 @@ To install ``tttrconvert`` from the source code clone the git repository and run
1518
setup script.
1619

1720
```commandline
18-
git clone https://gitlab.peulen.xyz/tpeulen/tttrconvert
21+
git clone https://github.com/fluorescence-tools/tttrconvert
1922
cd tttrconvert
2023
python setup.py install
2124
```
@@ -26,23 +29,17 @@ tttrconvert
2629
```
2730

2831
### Conda
29-
``tttrconvert`` depends on common python packages such as ``numpy``. Additionally, ``tttrconvert`` depends on
30-
``tttrlib``. Thus, to install ``k2dist`` make sure that conda channels that provide packages for the necessary
31-
dependencies are listed in the ``.condarc`` file
32-
33-
```yaml
34-
channels:
35-
- tpeulen
36-
- tpeulen/label/nightly
37-
- conda-forge
38-
- defaults
39-
```
32+
`tttrconvert` can be installed using conda, best in a separate
33+
environment
4034

41-
To avoid potential conflicts ``tttrconvert`` can be installed in a separate environment.
35+
```bash
36+
conda create tttrconvert
37+
mamba install tttrconvert -c tpeulen
38+
```
4239

43-
```commandline
44-
conda create -n test
45-
conda install tttrconvert
40+
To us the tool activate the tttrconvert environment and start the tool
41+
from the command line.
42+
```bash
4643
conda activate tttrconvert
4744
tttrconvert
4845
```
@@ -51,11 +48,7 @@ tttrconvert
5148

5249
## Graphical user interface
5350
First, select the input file type. Next, add files to the file list by drag-and-drop. Finally,
54-
select the ouput file format and save/convert the files.
55-
56-
## Note on meta-data
57-
The different TTTR file formats contain and support different meta-data. The meta-data may need to be
58-
edited separately.
51+
select the output file format and save/convert the files.
5952

6053

6154
[1]: doc/gui.png "tttrconvert GUI"

0 commit comments

Comments
 (0)