made a proper documentation

This commit is contained in:
Guillaume Raffy 2019-03-29 15:58:18 +01:00
parent f438c6f9a6
commit 69abd7e660
1 changed files with 17 additions and 2 deletions

View File

@ -1,5 +1,20 @@
# lipase
Projet lipase porté par vvie
An image processing software suite for the project lipase (Véronique Vié, Institut de Physique de Rennes)
A utiliser avec imageJ
This software suite is developed using Fiji (an image processing package based on imageJ).
## What it does
As the development is at its early stages, it does not much at the moment:
- loads a sequence of images into fiji in the form of an hyperstack (5d images : width, height, depth, channels, time)
## How to use
1. make sure that fiji is installed on your computer. If not, get it from https://fiji.sc/
2. launch fiji
3. from fiji, click on File->new->script... The script window should appear.
4. with the script window selected, choose the File->open... menu item.
5. from the file browser that just appeared, locate and choose the file lipase.py from this repository, then click Open. You should see the script lipase.py appear in the script window
6. The script is executed when you click on the script editor's run button.