Building MPRUN

Building MPRUN on all platforms

MPRUN can be built on MacOS, Windows, and Linux (UNTESTED)

0. Prerequisites

The following tools need to be installed on your computer:

• PyCharm↗️: code editor
• Python↗️: programming language
• Git↗️: version control system

1. Download source code

Open a terminal in your desired directory location and input git clone https://github.com/ktechhydle/mprun_repo.git

This will create a new directory titled "mprun_repo", this is the full project folder.

Now, open a terminal in the "mprun_repo" directory and type pip install -r requirements.txt

This will install the project requirements and libraries.

Finally, open a terminal in the "mprun_repo" directory and type git clone https://github.com/ktechhydle/mp_software_stylesheets.git

This will create the "mp_software_stylesheets" directory inside the "mprun_repo" directory, adding the stylesheets necessary for MPRUN to run.

2. Test run the app

Start PyCharm and open the "mprun_repo" directory, then navigate to the "main.py" python file.

Double click it, and click "Run" on PyCharm.

If all of these steps were completed correctly, you should see the MPRUN window popup.

3. Edit the source, have fun!

We made the codebase incredibly easy to navigate, so here's a list of what you might want to know before developing:

• Primary functionality is stored in "main.py"
• GUI related items (such as dialogs and widgets) are stored in the "src/gui" directory
• CSS (Qt) stylesheets are in the "mp_software_stylesheets" directory
• Graphics related elements (QGraphicsScene/View) are stored in the "src/framework" directory
• File serializing/deserializing is stored in "serializer.py"

Enjoy!