{
  "cells": [
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "\n# Graph plots\n\nUse the output of roxie defined graphs and plot them using plotly\n\nDownload Input files\n\n* :download:`dipole_2d.data <../../../../../examples/input_files/dipole_iron_trans_opt.data>`\n* :download:`dipole_2d.post.xml <../../../../../examples/input_files/dipole_iron_trans_opt.post.xml>`\n"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "## Setting up\nStandard Loading of input, Parsing and Initializing RoxiePlotOutputs object\n\n\n"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
        "collapsed": false
      },
      "outputs": [],
      "source": [
        "from roxieapi.output.plots import RoxiePlotOutputs\n\nplots = RoxiePlotOutputs(\n    \"../input_files/dipole_2D_trans_opt.post.xml\",\n    \"../input_files/dipole_2D_trans_opt.data\",\n)\n\nparser = plots.output\ngraphs = plots.graphs"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "## Listing all Roxie defined Graphs\nRoxie defines 3 types of graphs\n* Device graphs (for exery time step)\n* Transient graphs (Time dependent data)\n* Optimization graphs\n\nShows available plots for each segment\nNote that device plots also list 2D plots\n\n"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
        "collapsed": false
      },
      "outputs": [],
      "source": [
        "print(\"Device plots\")\nfor pl in parser.graphs_device:\n    print(f\"  - {pl}\")\nprint(\"Transient plots\")\nfor pl in parser.graphs_transient:\n    print(f\"  - {pl}\")\nprint(\"Optimization plots\")\nfor pl in parser.graphs_optimization:\n    print(f\"  - {pl}\")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "## Plotting a graph\nUsing the Graph plotter, each graph can be output\ndirectly as a plotly graph\n\n"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
        "collapsed": false
      },
      "outputs": [],
      "source": [
        "# Plot the first device plot graph in transient step 1, optimization step 1\n\nplots.output_optimization_graphs(plots=[5])\n\n# plots.output_device_graphs(1, 1, plots=[1])"
      ]
    }
  ],
  "metadata": {
    "kernelspec": {
      "display_name": "Python 3",
      "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.9.19"
    }
  },
  "nbformat": 4,
  "nbformat_minor": 0
}