Skip to content

README.md

Latest commit

 

History

History
76 lines (52 loc) · 2.14 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.14 KB

FPD-Explorer

A GUI visualizer for the FPD library

Getting started

A Python 3 installation is needed to run this program
Data from a STEM microscope is needed to make full use of the program's capabilities

Installing

Install FPD-Explorer package using the setup script from the project root:

python setup.py install

Dark style

A dark style is available for this program. It can be installed with either pip:

pip3 install git+git://github.com/09ubberboy90/qdarkgraystyle.git

or cloning the repository:

git clone https://github.com/09ubberboy90/qdarkgraystyle.git
cd qdarkgraystyle
python setup.py install

Interface compilation

Run this command from the project root before starting for the first time:

python compile_ui.py

Running

Run this command from the project root:

python main.py

Running the tests

Run this command from the project root:

pytest

Built with

  • Qt5 - The GUI framework used
  • PySide2 - Python wrapper for Qt5

Authors

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details

Acknowledgments

  • FPD library and its developer for providing the code needed to analyse the data
  • University of Glasgow School of Physics & Astronomy for giving us this project, especially Dr Damien McGrouther and Dr Trevor Almeida
  • University of Glasgow School of Computing Science for providing the courses without which this project would not have been possible
  • Justyna Toporkiewicz for being our coach and helping us during the development