mirror of
https://github.com/OPM/ResInsight.git
synced 2026-09-03 20:53:13 -05:00
#1641 Update libecl to latest revision from master
This commit is contained in:
Bjørnar Grip Fjær
Vendored
+29
-75
@@ -1,85 +1,39 @@
|
||||
option( ERT_RST_DOC "Build RST based documentation" ON)
|
||||
option( ERT_DOXY_DOC "Build doxygen documentation" ON)
|
||||
option( ERT_DOXY_GRAPHICAL "Add graphics to doxygen documentation" OFF)
|
||||
find_package(Sphinx REQUIRED)
|
||||
if (SPHINX_FOUND)
|
||||
set( ERT_DOC_INSTALL_PATH "" CACHE PATH "Absolute path to install documentation *in addition* to $PREFIX/documentation")
|
||||
set( ERT_DOC_EXTERNAL_ROOT "" CACHE PATH "Path to site local ERT documentation")
|
||||
|
||||
if (NOT BUILD_ERT)
|
||||
if (ERT_RST_DOC)
|
||||
message(WARNING "Turning off ERT_RST_DOC. Depends on BUILD_ERT.")
|
||||
set (ERT_RST_DOC OFF)
|
||||
endif()
|
||||
if (ERT_DOXY_DOC)
|
||||
message(WARNING "Turning off ERT_DOXY_DOC. Depends on BUILD_ERT.")
|
||||
set (ERT_DOXY_DOC OFF)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if (ERT_RST_DOC)
|
||||
find_package(Sphinx REQUIRED)
|
||||
if (SPHINX_FOUND)
|
||||
set( ERT_DOC_INSTALL_PATH "" CACHE PATH "Absolute path to install documentation *in addition* to $PREFIX/documentation")
|
||||
set( ERT_DOC_EXTERNAL_ROOT "" CACHE PATH "Path to site local ERT documentation")
|
||||
|
||||
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/doc-src")
|
||||
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/doc-src/_static")
|
||||
EXECUTE_PROCESS( COMMAND ${CMAKE_COMMAND} -E create_symlink "${CMAKE_CURRENT_SOURCE_DIR}/user" "${PROJECT_BINARY_DIR}/doc-src/user")
|
||||
|
||||
if (ERT_DOC_EXTERNAL_ROOT)
|
||||
EXECUTE_PROCESS( COMMAND ${CMAKE_COMMAND} -E create_symlink "${ERT_DOC_EXTERNAL_ROOT}" "${PROJECT_BINARY_DIR}/doc-src/external-doc")
|
||||
message(STATUS "Adding documentation link ${PROJECT_BINARY_DIR}/doc-src/external-doc -> ${ERT_DOC_EXTERNAL_ROOT}")
|
||||
set( ERT_DOC_LINK external-doc/index )
|
||||
else()
|
||||
set( ERT_DOC_LINK "" )
|
||||
endif()
|
||||
|
||||
configure_file(index.rst.in ${PROJECT_BINARY_DIR}/doc-src/index.rst)
|
||||
configure_file(conf.py.in ${PROJECT_BINARY_DIR}/doc-src/conf.py)
|
||||
|
||||
if (BUILD_PYTHON)
|
||||
EXECUTE_PROCESS( COMMAND ${CMAKE_COMMAND} -E create_symlink "${CMAKE_CURRENT_SOURCE_DIR}/code" "${PROJECT_BINARY_DIR}/doc-src/code")
|
||||
add_custom_target(api-doc ALL
|
||||
COMMAND sphinx-apidoc -e -o doc-src/API/python ${PROJECT_BINARY_DIR}/${PYTHON_INSTALL_PREFIX}
|
||||
DEPENDS enkf
|
||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
|
||||
endif()
|
||||
|
||||
add_custom_target(rst-doc ALL
|
||||
COMMAND sphinx-build -b html -d doc-src/doctrees doc-src documentation/rst
|
||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
||||
DEPENDS api-doc
|
||||
)
|
||||
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/doc-src")
|
||||
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/doc-src/_static")
|
||||
EXECUTE_PROCESS( COMMAND ${CMAKE_COMMAND} -E create_symlink "${CMAKE_CURRENT_SOURCE_DIR}/user" "${PROJECT_BINARY_DIR}/doc-src/user")
|
||||
|
||||
if (ERT_DOC_EXTERNAL_ROOT)
|
||||
EXECUTE_PROCESS( COMMAND ${CMAKE_COMMAND} -E create_symlink "${ERT_DOC_EXTERNAL_ROOT}" "${PROJECT_BINARY_DIR}/doc-src/external-doc")
|
||||
message(STATUS "Adding documentation link ${PROJECT_BINARY_DIR}/doc-src/external-doc -> ${ERT_DOC_EXTERNAL_ROOT}")
|
||||
set( ERT_DOC_LINK external-doc/index )
|
||||
else()
|
||||
message(STATUS "Sphinx documentation tool not found - documentation not generated")
|
||||
set( ERT_DOC_LINK "" )
|
||||
endif()
|
||||
endif()
|
||||
|
||||
configure_file(index.rst.in ${PROJECT_BINARY_DIR}/doc-src/index.rst)
|
||||
configure_file(conf.py.in ${PROJECT_BINARY_DIR}/doc-src/conf.py)
|
||||
|
||||
if (ERT_DOXY_DOC)
|
||||
find_package(Doxygen)
|
||||
if (DOXYGEN_FOUND)
|
||||
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/documentation/doxy")
|
||||
set( DOXYGEN_HAVE_DOT "NO" )
|
||||
if ( ERT_DOXY_GRAPHICAL)
|
||||
if (DOXYGEN_DOT_FOUND)
|
||||
set( DOXYGEN_HAVE_DOT "YES" )
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if (BUILD_ERT)
|
||||
SET( DOXYGEN_INPUT "${PROJECT_SOURCE_DIR}/libanalysis ${PROJECT_SOURCE_DIR}/libconfig ${PROJECT_SOURCE_DIR}/libecl ${PROJECT_SOURCE_DIR}/libecl_well ${PROJECT_SOURCE_DIR}/libeclxx ${PROJECT_SOURCE_DIR}/libenkf ${PROJECT_SOURCE_DIR}/libert_util ${PROJECT_SOURCE_DIR}/libert_utilxx ${PROJECT_SOURCE_DIR}/libgeometry ${PROJECT_SOURCE_DIR}/libjob_queue ${PROJECT_SOURCE_DIR}/librms ${PROJECT_SOURCE_DIR}/libsched")
|
||||
else()
|
||||
SET( DOXYGEN_INPUT "${PROJECT_SOURCE_DIR}/libecl ${PROJECT_SOURCE_DIR}/libecl_well ${PROJECT_SOURCE_DIR}/libeclxx ${PROJECT_SOURCE_DIR}/libert_util ${PROJECT_SOURCE_DIR}/libert_utilxx ${PROJECT_SOURCE_DIR}/libgeometry")
|
||||
endif()
|
||||
|
||||
configure_file(doxygen.cfg.in ${PROJECT_BINARY_DIR}/doxygen.cfg)
|
||||
add_custom_target(doxy ALL
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doxygen.cfg
|
||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/../
|
||||
COMMENT "Generating doxygen documentation"
|
||||
DEPENDS enkf)
|
||||
|
||||
if (BUILD_PYTHON)
|
||||
add_custom_target(api-doc ALL
|
||||
COMMAND ${CMAKE_COMMAND} -E create_symlink "${CMAKE_CURRENT_SOURCE_DIR}/code" "${PROJECT_BINARY_DIR}/doc-src/code"
|
||||
COMMAND sphinx-apidoc -e -o doc-src/API/python ${PROJECT_BINARY_DIR}/${PYTHON_INSTALL_PREFIX}
|
||||
DEPENDS ecl
|
||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR})
|
||||
endif()
|
||||
endif()
|
||||
|
||||
add_custom_target(rst-doc ALL
|
||||
COMMAND sphinx-build -b html -d doc-src/doctrees doc-src documentation/rst
|
||||
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
|
||||
DEPENDS api-doc
|
||||
)
|
||||
|
||||
else()
|
||||
message(STATUS "Sphinx documentation tool not found - documentation not generated")
|
||||
endif()
|
||||
|
||||
INSTALL( DIRECTORY ${PROJECT_BINARY_DIR}/documentation DESTINATION ${CMAKE_INSTALL_PREFIX} )
|
||||
|
||||
-188
@@ -1,188 +0,0 @@
|
||||
.\" First parameter, NAME, should be all caps
|
||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
||||
.\" other parameters are allowed: see man(7), man(1)
|
||||
.TH ecl_summary "1" "November 8 2016"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
.\" .nh disable hyphenation
|
||||
.\" .hy enable hyphenation
|
||||
.\" .ad l left justify
|
||||
.\" .ad b justify to both left and right margins
|
||||
.\" .nf disable filling
|
||||
.\" .fi enable filling
|
||||
.\" .br insert line break
|
||||
.\" .sp <n> insert n+1 empty lines
|
||||
.\" for manpage-specific macros, see man(7)
|
||||
.SH NAME
|
||||
ecl_summary \- Program to extract summary vectors from ECLIPSE files
|
||||
.SH DESCRIPTION
|
||||
The ecl_summary program is used to quickly extract summary vectors
|
||||
from ECLIPSE summary files. The program is invoked as:
|
||||
.PP
|
||||
computer> ecl_summary \fI\,/Path/to/ECLIPSE\/\fP key1 key2 key3 ....
|
||||
.PP
|
||||
Here ECLIPSE is the name of an existing case, you can give it with
|
||||
extension, or without; the case need not be in the current directory.
|
||||
.PP
|
||||
The keys are formed by combining ECLIPSE variable names and
|
||||
qualifiers from the WGNAMES and NUMS arrays. Examples of keys are:
|
||||
.TP
|
||||
WWCT:F\-36
|
||||
\- The watercut in the well F\-36.
|
||||
.TP
|
||||
FOPT
|
||||
\- The total field oil production.
|
||||
.TP
|
||||
RPR:3
|
||||
\- The region pressure in region 3.
|
||||
.TP
|
||||
GGIT:NORTH
|
||||
\- The total gas injection group NORTH.
|
||||
.TP
|
||||
SPR:F\-12:18
|
||||
\- The segment pressure in well F\-12, segment 18.
|
||||
.TP
|
||||
BPR:10,10,10
|
||||
\- The block pressure in cell 10,10,10.
|
||||
.IP
|
||||
LBPR:LGR3:10,10,10 \- The block pressure in cell 10,10,10 \- in LGR3
|
||||
.PP
|
||||
The option \fB\-\-list\fR can be used to list all available keys.
|
||||
.SH OPTIONS
|
||||
.HP
|
||||
\fB\-\-list\fR : The program will list available keys.
|
||||
.HP
|
||||
\fB\-\-no\-restart\fR: If the simulation in question is a restart, i.e a prediction
|
||||
.IP
|
||||
which starts at the end of the historical period, the ecl_summary
|
||||
program will by default also load historical data. If the \fB\-\-no\-restart\fR
|
||||
option is used the program will not look for old results.
|
||||
.HP
|
||||
\fB\-\-no\-header\fR: By default ecl_summary will print a header line at the top, with the
|
||||
.IP
|
||||
option \fB\-\-no\-header\fR this will be suppressed.
|
||||
.HP
|
||||
\fB\-\-report\-only\fR: Will only report results at report times (i.e. DATES).
|
||||
.HP
|
||||
\fB\-\-help\fR: Print this message and exit.
|
||||
.PP
|
||||
The options should come before the ECLIPSE basename.
|
||||
.PP
|
||||
Example1:
|
||||
.TP
|
||||
computer> ecl_summary
|
||||
CASE1_XXX WWCT:F\-36 FOPT FWPT
|
||||
.IP
|
||||
This example will load results from case 'CASE1_XXX' and print the
|
||||
results for keys 'WWCT:F\-36', 'FOPT' and 'FWPT' on standard out.
|
||||
.PP
|
||||
Example2:
|
||||
.TP
|
||||
computer> ecl_summary
|
||||
\fB\-\-list\fR CASE2_XXX "*:F\-36" "BPR:*"
|
||||
.IP
|
||||
This example will list all the available keys which end with
|
||||
\&':F\-36' and those which start with 'BPR:'. Observe the use of
|
||||
quoting characters "" when using shell wildcards.
|
||||
.PP
|
||||
The ecl_summary program will look for and load both unified and
|
||||
non\-unified and formatted and non\-formatted files. The default
|
||||
search order is: UNSMRY, Snnnn, FUNSMRY, Annnn, however you can
|
||||
manipulate this with the extension to the basename:
|
||||
.PP
|
||||
* If the extension corresponds to an unformatted file, ecl_summary
|
||||
.IP
|
||||
will only look for unformatted files.
|
||||
.PP
|
||||
* If the extension corresponds to a unified file, ecl_summary will
|
||||
.IP
|
||||
only look for unified files.
|
||||
.PP
|
||||
Contact Joakim Hove / joaho@statoil.com / 92 68 57 04 for bugs
|
||||
and feature requests.
|
||||
.PP
|
||||
The ecl_summary program is used to quickly extract summary vectors
|
||||
from ECLIPSE summary files. The program is invoked as:
|
||||
.PP
|
||||
computer> ecl_summary \fI\,/Path/to/ECLIPSE\/\fP key1 key2 key3 ....
|
||||
.PP
|
||||
Here ECLIPSE is the name of an existing case, you can give it with
|
||||
extension, or without; the case need not be in the current directory.
|
||||
.PP
|
||||
The keys are formed by combining ECLIPSE variable names and
|
||||
qualifiers from the WGNAMES and NUMS arrays. Examples of keys are:
|
||||
.TP
|
||||
WWCT:F\-36
|
||||
\- The watercut in the well F\-36.
|
||||
.TP
|
||||
FOPT
|
||||
\- The total field oil production.
|
||||
.TP
|
||||
RPR:3
|
||||
\- The region pressure in region 3.
|
||||
.TP
|
||||
GGIT:NORTH
|
||||
\- The total gas injection group NORTH.
|
||||
.TP
|
||||
SPR:F\-12:18
|
||||
\- The segment pressure in well F\-12, segment 18.
|
||||
.TP
|
||||
BPR:10,10,10
|
||||
\- The block pressure in cell 10,10,10.
|
||||
.IP
|
||||
LBPR:LGR3:10,10,10 \- The block pressure in cell 10,10,10 \- in LGR3
|
||||
.PP
|
||||
The option \fB\-\-list\fR can be used to list all available keys.
|
||||
.HP
|
||||
\fB\-\-list\fR : The program will list available keys.
|
||||
.HP
|
||||
\fB\-\-no\-restart\fR: If the simulation in question is a restart, i.e a prediction
|
||||
.IP
|
||||
which starts at the end of the historical period, the ecl_summary
|
||||
program will by default also load historical data. If the \fB\-\-no\-restart\fR
|
||||
option is used the program will not look for old results.
|
||||
.HP
|
||||
\fB\-\-no\-header\fR: By default ecl_summary will print a header line at the top, with the
|
||||
.IP
|
||||
option \fB\-\-no\-header\fR this will be suppressed.
|
||||
.HP
|
||||
\fB\-\-report\-only\fR: Will only report results at report times (i.e. DATES).
|
||||
.HP
|
||||
\fB\-\-help\fR: Print this message and exit.
|
||||
.PP
|
||||
The options should come before the ECLIPSE basename.
|
||||
.PP
|
||||
Example1:
|
||||
.TP
|
||||
computer> ecl_summary
|
||||
CASE1_XXX WWCT:F\-36 FOPT FWPT
|
||||
.IP
|
||||
This example will load results from case 'CASE1_XXX' and print the
|
||||
results for keys 'WWCT:F\-36', 'FOPT' and 'FWPT' on standard out.
|
||||
.PP
|
||||
Example2:
|
||||
.TP
|
||||
computer> ecl_summary
|
||||
\fB\-\-list\fR CASE2_XXX "*:F\-36" "BPR:*"
|
||||
.IP
|
||||
This example will list all the available keys which end with
|
||||
\&':F\-36' and those which start with 'BPR:'. Observe the use of
|
||||
quoting characters "" when using shell wildcards.
|
||||
.PP
|
||||
The ecl_summary program will look for and load both unified and
|
||||
non\-unified and formatted and non\-formatted files. The default
|
||||
search order is: UNSMRY, Snnnn, FUNSMRY, Annnn, however you can
|
||||
manipulate this with the extension to the basename:
|
||||
.PP
|
||||
* If the extension corresponds to an unformatted file, ecl_summary
|
||||
.IP
|
||||
will only look for unformatted files.
|
||||
.PP
|
||||
* If the extension corresponds to a unified file, ecl_summary will
|
||||
.IP
|
||||
only look for unified files.
|
||||
.PP
|
||||
Contact Joakim Hove / joaho@statoil.com / 92 68 57 04 for bugs
|
||||
and feature requests.
|
||||
|
||||
Reference in New Issue
Block a user