{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Flow360 API Quickstart\n",
"\n",
"Flow360 can be automatically driven via our powerful Python API. All the case setup parameters available in the WebUI are available in the Python API.\n",
"\n",
"By starting from the same [evtol_quickstart_grouped.csm](https://simcloud-public-1.s3.amazonaws.com/quickstart/evtol_quickstart_grouped.csm), the EVTOL quickstart case shown previously can be easily launched."
],
"id": "b289ba4d"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Import necessary modules\n",
"\n",
"First, we import the required modules from the Flow360 library:"
],
"id": "c07706a6"
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"from matplotlib.pyplot import show\n",
"\n",
"import flow360 as fl\n",
"from flow360.examples import EVTOL"
],
"id": "10f72deb"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Step 1: Create a new project\n",
"\n",
"Create a new project from a predefined geometry file in the EVTOL example. This initializes a project with the specified geometry and assigns it a name."
],
"id": "453cd4fb"
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "1417bbf11f4c449fb05a03d7099c835a",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Output()"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"[14:09:43] INFO : Geometry successfully submitted: \n",
" type = Geometry \n",
" name = Python Project ( Geometry, from file) \n",
" id = geo-4a2412d4-786e-4aa6-a7d1-1242a3e8ae63 \n",
" status = uploaded \n",
" project id = prj-8d95954b-152d-4574-9f87-63e755a2bcb1 \n",
" \n",
" INFO : Waiting for geometry to be processed. \n",
"[14:11:32] INFO : Regrouping face entities under `groupName` tag ( previous `_color`) . \n",
" INFO : using: SI unit system for unit inference. \n",
" INFO : using: SI unit system for unit inference. \n",
"[14:11:35] INFO : Successfully submitted: \n",
" type = Case \n",
" name = Case of EVTOL from Python \n",
" id = case-9a16e08c-935c-41bd-8ffc-a9095f7ba0e6 \n",
" status = pending \n",
" project id = prj-8d95954b-152d-4574-9f87-63e755a2bcb1 \n",
" \n",
"[14:15:41] INFO : Saved to /tmp/tmpjrj0fzrd/ 5734bde9-ec89-4ef8-9609-75c75887efdf.csv \n",
""
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"case = project.case\n",
"case.wait()\n",
"\n",
"total_forces = case.results.total_forces.as_dataframe()\n",
"total_forces.plot(\"pseudo_step\", [\"CL\", \"CD\"], ylim=[-5, 15])\n",
"show()"
],
"id": "6d271bf3"
}
],
"metadata": {
"kernelspec": {
"display_name": "flow360",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.13"
}
},
"nbformat": 4,
"nbformat_minor": 5
}