mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Remove obsolete doc files
This commit is contained in:
Magne Sjaastad
parent
605af789c6
commit
5fccd143ba
@ -1,7 +1,3 @@
|
||||
You need sphinx to update the documentation.
|
||||
|
||||
pip install sphinx sphinx-markdown-builder
|
||||
|
||||
To update run "make markdown" to update to reflect changes to the python code.
|
||||
The generated files are located in build/markdown
|
||||
The documentation is moved to
|
||||
|
||||
https://github.com/OPM/ResInsight-UserDocumentation/tree/master/docs
|
||||
@ -1,35 +0,0 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
@ -1,39 +0,0 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
|
||||
REM Copy files to deployment folder using second parameter
|
||||
REM Example "d:\gitroot\ResInsight-UserDocumentation\content\scripting"
|
||||
xcopy /Y build\markdown %2
|
||||
@ -1,134 +0,0 @@
|
||||
+++
|
||||
title = "Python Examples"
|
||||
published = true
|
||||
weight = 40
|
||||
+++
|
||||
|
||||
![]({{< relref "" >}}images/scripting/python-logo-master-v3-TM.png)
|
||||
|
||||
This pages is created based on the content in the **PythonExamples** folder located inside the **rips** module, made available online for convenience.
|
||||
|
||||
|
||||
AllCases
|
||||
--------
|
||||
.. literalinclude:: ../../rips/PythonExamples/all_cases.py
|
||||
|
||||
AllSimulationWells
|
||||
------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/all_simulation_wells.py
|
||||
|
||||
AllWells
|
||||
--------
|
||||
.. literalinclude:: ../../rips/PythonExamples/all_wells.py
|
||||
|
||||
AlterWbsPlot
|
||||
------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/alter_wbs_plot.py
|
||||
|
||||
CaseGridGroup
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/case_grid_group.py
|
||||
|
||||
CaseInfoStreamingExample
|
||||
------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/case_info_streaming_example.py
|
||||
|
||||
CellResultData
|
||||
--------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/cell_result_data.py
|
||||
|
||||
CommandExample
|
||||
--------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/command_example.py
|
||||
|
||||
Create WBS Plot
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/create_wbs_plot.py
|
||||
|
||||
ErrorHandling
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/error_handling.py
|
||||
|
||||
ExportContourMaps
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/export_contour_maps.py
|
||||
|
||||
ExportPlots
|
||||
-----------
|
||||
.. literalinclude:: ../../rips/PythonExamples/export_plots.py
|
||||
|
||||
ExportSnapshots
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/export_snapshots.py
|
||||
|
||||
GridInformation
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/grid_information.py
|
||||
|
||||
Import Well Paths
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/import_well_paths_and_logs.py
|
||||
|
||||
InputPropTestAsync
|
||||
------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/input_prop_test_async.py
|
||||
|
||||
InputPropTestSync
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/input_prop_test_sync.py
|
||||
|
||||
InstanceExample
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/instance_example.py
|
||||
|
||||
LaunchWithCommandLineOptions
|
||||
----------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/launch_with_commandline_options.py
|
||||
|
||||
Launch Using Command Line Options
|
||||
---------------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/launch_with_commandline_options.py
|
||||
|
||||
NewSummaryPlot
|
||||
--------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/new_summary_plot.py
|
||||
|
||||
SelectedCases
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/selected_cases.py
|
||||
|
||||
SelectedCells
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/selected_cells.py
|
||||
|
||||
SetCellResult
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/set_cell_result.py
|
||||
|
||||
SetFlowDiagnosticsResult
|
||||
------------------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/set_flow_diagnostics_result.py
|
||||
|
||||
SetGridProperties
|
||||
-----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/set_grid_properties.py
|
||||
|
||||
SoilAverageAsync
|
||||
----------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/soil_average_async.py
|
||||
|
||||
SoilAverageSync
|
||||
---------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/soil_average_sync.py
|
||||
|
||||
SoilPorvAsync
|
||||
-------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/soil_porv_async.py
|
||||
|
||||
SoilPorvSync
|
||||
------------
|
||||
.. literalinclude:: ../../rips/PythonExamples/soil_porv_sync.py
|
||||
|
||||
ViewExample
|
||||
-----------
|
||||
.. literalinclude:: ../../rips/PythonExamples/view_example.py
|
||||
@ -1,9 +0,0 @@
|
||||
+++
|
||||
title = "Python API - rips"
|
||||
published = true
|
||||
weight = 42
|
||||
+++
|
||||
|
||||
![]({{< relref "" >}}images/scripting/python-logo-master-v3-TM.png)
|
||||
|
||||
.. include:: rips.rst
|
||||
@ -1,64 +0,0 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath("../../"))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = "rips"
|
||||
copyright = "2019, Ceetron Solutions AS"
|
||||
author = "Ceetron Solutions AS"
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = "2019.04.01"
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_markdown_builder"]
|
||||
|
||||
master_doc = "PythonRips"
|
||||
|
||||
napoleon_google_docstring = True
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ["build/*", "rips.rst"]
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "alabaster"
|
||||
|
||||
smartquotes = False
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ["_static"]
|
||||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
@ -1,113 +0,0 @@
|
||||
Instance Module
|
||||
===============
|
||||
|
||||
.. autoclass:: rips.instance.Instance
|
||||
:members:
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. literalinclude:: ../../rips/PythonExamples/instance_example.py
|
||||
:language: python
|
||||
:lines: 5-
|
||||
:emphasize-lines: 3
|
||||
|
||||
Case Module
|
||||
===========
|
||||
.. autoclass:: rips.case.Case
|
||||
:members:
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. literalinclude:: ../../rips/PythonExamples/all_cases.py
|
||||
:language: python
|
||||
:lines: 5-
|
||||
:emphasize-lines: 5
|
||||
|
||||
Contour Map Module
|
||||
==================
|
||||
|
||||
.. autoclass:: rips.contour_map.EclipseContourMap
|
||||
:members:
|
||||
|
||||
.. autoclass:: rips.contour_map.GeoMechContourMap
|
||||
:members:
|
||||
|
||||
Grid Module
|
||||
===========
|
||||
|
||||
.. autoclass:: rips.grid.Grid
|
||||
:members:
|
||||
|
||||
Example
|
||||
-------
|
||||
.. code-block:: python
|
||||
|
||||
case = rips_instance.project.loadCase(path=casePath)
|
||||
print (case.gridCount())
|
||||
if case.gridCount() > 0:
|
||||
grid = case.grid(index=0)
|
||||
dimensions = grid.dimensions()
|
||||
print(dimensions.i)
|
||||
print(dimensions.j)
|
||||
print(dimensions.k)
|
||||
|
||||
GridCaseGroup Module
|
||||
====================
|
||||
|
||||
.. autoclass:: rips.gridcasegroup.GridCaseGroup
|
||||
:members:
|
||||
|
||||
|
||||
Plot Module
|
||||
==============
|
||||
|
||||
.. autoclass:: rips.project.Plot
|
||||
:members:
|
||||
|
||||
Project Module
|
||||
==============
|
||||
|
||||
.. autoclass:: rips.project.Project
|
||||
:members:
|
||||
|
||||
|
||||
Simulation Well Module
|
||||
======================
|
||||
|
||||
.. autoclass:: rips.simulation_well.SimulationWell
|
||||
:members:
|
||||
|
||||
View Module
|
||||
===========
|
||||
|
||||
.. autoclass:: rips.view.View
|
||||
:members:
|
||||
|
||||
Well Log Plot Module
|
||||
====================
|
||||
|
||||
.. autoclass:: rips.well_log_plot.WellLogPlot
|
||||
:members:
|
||||
|
||||
Synchronous Example
|
||||
-------------------
|
||||
Read two properties, multiply them together and push the results back to ResInsight in a naïve way, by reading PORO into a list, then reading PERMX into a list, then multiplying them both in a resulting list and finally transferring back the list.
|
||||
|
||||
This is slow and inefficient, but works.
|
||||
|
||||
.. literalinclude:: ../../rips/PythonExamples/input_prop_test_async.py
|
||||
:language: python
|
||||
:lines: 5-
|
||||
|
||||
Asynchronous Example
|
||||
--------------------
|
||||
Read two properties at the same time chunk by chunk, multiply each chunk together and start transferring the result back to ResInsight as soon as the chunk is finished.
|
||||
|
||||
This is far more efficient.
|
||||
|
||||
.. literalinclude:: ../../rips/PythonExamples/input_prop_test_sync.py
|
||||
:language: python
|
||||
:lines: 5-
|
||||
|
||||
Loading…
Reference in New Issue
Block a user