Skip to content
Snippets Groups Projects
Unverified Commit 29af1a43 authored by RLennart's avatar RLennart Committed by GitHub
Browse files

Update README.rst

adding links in readme
parent 6e0f635a
No related branches found
No related tags found
No related merge requests found
......@@ -7,6 +7,11 @@ INSIGHT
Processing detector images for analyzing in-situ and in-operando GIWAXS and GISAXS data.
The corresponding publication can be found at [link](https://doi.org/10.1107/S1600576723011159).
Here you can find the link to an online executable Jupyter Notebook [demo](https://colab.research.google.com/drive/1OEjcewGFovH7DAzFtZtvwkVxSM2wG3mZ?usp=sharing).
What INSIGHT can do
--------------
......@@ -39,7 +44,7 @@ INSIGHT is optimized for batch processing.
- tracking the fitting parameters during evolution
- SDD normalization for each image
And it does it all flexibly - you can decide whether to closely follow the steps interactively or do one-click analysis when all is set up.
And it does it all flexibly - you can decide whether to closely follow the steps interactively or do a one-click analysis when all is set up.
Documentation
......@@ -49,7 +54,7 @@ More information is available in the documentation file or the demo files.
Demo files
-----
Multiple demo files are available to demonstrate the capabilities of INSGIHT and give users a starting point.
Multiple demo files are available to demonstrate the capabilities of INSIGHT and give users a starting point.
The demo scripts can be easily extended and changed - and can be the base for your first INSIGHT script!
INSIGHT installation
......@@ -61,17 +66,17 @@ INSIGHT can be installed via ::
PATH is the full path to the tar or gz files on your local system.
Python version 3.8 or higher is recommended. INSGIHT is dependent on multiple packages that are installed automatically when calling pip.
Python version 3.8 or higher is recommended. INSIGHT is dependent on multiple packages that are installed automatically when calling pip.
These include: numpy, pandas, matplotlib, lmfitL, fabio, scipy, datetime, scikit-image, astropy, fast-histogram, ipython, h5py, numba, pyqt5, numexpr, pathos.
Licence information
License information
-----
INSIGHT: In Situ GIXS Heuristic Tool
Copyright (c) 2021 Manuel A. Reus, Lennart K. Reb
Copyright (c) 2024 Manuel A. Reus, Lennart K. Reb
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
......@@ -91,13 +96,3 @@ Contact information
-----
mail: insight@ph.tum.de
| Prof. Peter Müller-Buschbaum
| Technical University of Munich
| TUM School of Natural Sciences
| Department of Physics
| Chair for Functional Materials
| James-Franck-Str. 1
| 85748 Garching
| Germany
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment