Skip to content

README - Dev.md

Latest commit

 

History

History
27 lines (19 loc) · 1.67 KB

README - Dev.md

File metadata and controls

27 lines (19 loc) · 1.67 KB

MUltiple tests corrections and FOrmatted tables Software (MUFOS)

For developers - General notes

Information about the software development, its architecture, quality control and reuse potential (i.e. how it can be built upon), please see the this preprint (link coming soon).

For additional information about underlying procedures and calculations, see the MUFOS Help Guide and Documentation document.

Run instructions

  1. Make sure you have Python 3.8 installed.
  2. Navigate to the source code and run pip install -r requirements.txt in your shell in order to install all of the required packages.
  3. Run the _ROOT.py file.

Build instructions

  1. Make sure you have Python 3.8 installed as well as the latest version of pyinstaller (get it by running pip install pyinstaller).
  2. Navigate to the source code.
  3. Run pip install -r requirements.txt
  4. Run pyinstaller mufosWindowsSpec.spec (or pyinstaller mufosMacSpec.spec)

This procedure will yield a dist folder, which contains a MUFOS executable file.

Note: when packaging for MacOs, there is a known issue with tkinter (see here). The solution used is copying the msgcat-1.6.1.tm into one of the tk folders - see here.

Support

In case of any problems, questions or feedback, please contact the leading developer at nikbpetrov@gmail.com.

Copyright (C) 2022 Nikolay Petrov, Vasil Atanasov, & Trevor Thompson