Files
ResInsight/docs/source/PythonExamples.rst
Magne Sjaastad d675db98f6 Update python doc (#5803)
Several improvement and adjustments to the Python documentation

- applied autopep8
- add summary example
- use references to reference other classes and methods
2020-04-16 16:06:18 +02:00

165 lines
5.3 KiB
ReStructuredText

Python Examples
---------------
This pages is created based on the content in the **PythonExamples** folder located inside the **rips** module, made available online for convenience.
========
AllCases
========
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_cases.py
==================
AllSimulationWells
==================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_simulation_wells.py
========
AllWells
========
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/all_wells.py
============
AlterWbsPlot
============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/alter_wbs_plot.py
=============
CaseGridGroup
=============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/case_grid_group.py
=================
CaseInfoStreaming
=================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/case_info_streaming_example.py
==============
CellResultData
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/cell_result_data.py
==============
CommandExample
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/command_example.py
===============
Create WBS Plot
===============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/create_wbs_plot.py
=============
ErrorHandling
=============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/error_handling.py
=================
ExportContourMaps
=================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_contour_maps.py
===========
ExportPlots
===========
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_plots.py
===============
ExportSnapshots
===============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/export_snapshots.py
===============
GridInformation
===============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/grid_information.py
=================
Import Well Paths
=================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/import_well_paths_and_logs.py
==================
InputPropTestAsync
==================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/input_prop_test_async.py
=================
InputPropTestSync
=================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/input_prop_test_sync.py
===============
InstanceExample
===============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/instance_example.py
============================
LaunchWithCommandLineOptions
============================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/launch_with_commandline_options.py
=================================
Launch Using Command Line Options
=================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/launch_with_commandline_options.py
==============
NewSummaryPlot
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/new_summary_plot.py
==============
SelectedCases
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/selected_cases.py
==============
SelectedCells
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/selected_cells.py
==============
SetCellResult
==============
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_cell_result.py
========================
SetFlowDiagnosticsResult
========================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_flow_diagnostics_result.py
==================
SetGridProperties
==================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/set_grid_properties.py
==================================
SoilAverageAsync
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_average_async.py
==================================
SoilAverageSync
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_average_sync.py
==================================
SoilPorvAsync
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_porv_async.py
==================================
SoilPorvSync
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/soil_porv_sync.py
==================================
SummaryVectors
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/summary_vectors.py
==================================
ViewExample
==================================
.. literalinclude:: ../../ApplicationCode/GrpcInterface/Python/rips/PythonExamples/view_example.py