Skip to content

Commit 41a7fe5

Browse files
aritortoaritorto
committed
Deploying to gh-pages-testSetUp from @ f5a2c3c 🚀
1 parent 5f8c889 commit 41a7fe5

116 files changed

Lines changed: 24156 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.nojekyll‎

Whitespace-only changes.

‎index.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
<!DOCTYPE html>
3+
<html>
4+
<head>
5+
<meta http-equiv="refresh" content="0; url =
6+
master/index.html" />
7+
</head>
8+

‎master/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 41adc869cf6477573308c6dea56426f7
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎master/.doctrees/common.doctree‎

1.05 MB
Binary file not shown.

‎master/.doctrees/embedded-python.doctree‎

28.9 KB
Binary file not shown.

‎master/.doctrees/environment.pickle‎

1.77 MB
Binary file not shown.

‎master/.doctrees/flow-in-python.doctree‎

12.3 KB
Binary file not shown.

‎master/.doctrees/index.doctree‎

7.79 KB
Binary file not shown.

‎master/.doctrees/simulators.doctree‎

75.8 KB
Binary file not shown.

‎master/_sources/common.rst.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
OPM Common Python Documentation
2+
===============================
3+
4+
Note on Import Paths
5+
--------------------
6+
7+
In this documentation, some classes are referenced with their full import paths (e.g., `opm.io.ecl.EGrid <common.html#opm.io.ecl.EGrid>`_), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
8+
9+
- Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the ``__init__`` method. For example:
10+
11+
.. code-block:: python
12+
13+
from opm.io.ecl import EGrid
14+
15+
16+
- Unqualified Class Names: Classes displayed with just their names, e.g., Connection, do not have constructors in Python and cannot be directly instantiated in Python. Objects of these classes might be return values of methods of other classes.
17+
18+
Documentation
19+
-------------
20+
21+
.. opm_common_docstrings::

0 commit comments

Comments
 (0)