Quickstart

Installation

To install this tool, you can simply use the pip install command like so:

pip install mpcforces-extractor

After installing it, you can access the cli tool via: mpcforces-extractor which will start the app.

Alternatively you can use the command line interface tool (CLI)

Taskfile

The below described approach is for more development oriented people. If you are not interested in this, you can skip this section and use the CLI tool described above.

The project has a Taskfile.yaml for your conveinience. Taskfile is an executeable file which you can download on: Taskfile and it makes your life easier.

In the Taskfile you have commands available to start the program namely:

task run

which does the following:

poetry run python -m mpcforces_extractor.main

alternatively you can start the tool also with the python -m command.

If you want to run the program in the APP / Browser mode:

task app

which runs:

poetry run python -m mpcforces_extractor.app

which in turn stats the uvicorn server and let's you run it in your browser.