Skip to content

Quick start

Rich Mayne edited this page Oct 4, 2024 · 4 revisions

Quick-start: GUI

  1. Install GRAViTy-V2 (see Installation)
  2. Navigate to your GRAViTy-V2 directory with $ cd
  3. Start the GRAViTy-V2 server with $ gravity (or, if not using a Bash shell/not followed the final step of installation instructions, activate your Conda environment with $ conda activate gravity then start the server with $ uvicorn app.api:app --reload --port 8000)
  4. Visit the graphical user interface in your browser at http://127.0.0.1:8000/docs

Endpoints (function) are dialogue boxes that can be edited by clicking on them, then clicking the "try it now" button. Users set parameters by modifying fields in the dialogue box, then runs can be started by hitting "execute".

N.b. dialogue box formatting must be preserved! I.e. quotation marks, commas, line breaks, lower-case booleans etc., as per JSON standard.

Clone this wiki locally