From 203f93694b1515f3ed4005aa2f6800749a879ad7 Mon Sep 17 00:00:00 2001 From: David Landa Marban Date: Sun, 14 Jul 2024 17:02:43 +0200 Subject: [PATCH] Updating the documentation --- docs/_sources/api.rst.txt | 2 +- docs/_sources/introduction.rst.txt | 8 ++++---- docs/api.html | 2 +- docs/introduction.html | 8 ++++---- docs/searchindex.js | 2 +- docs/text/api.rst | 2 +- docs/text/introduction.rst | 8 ++++---- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt index e0ca002..e2d407c 100644 --- a/docs/_sources/api.rst.txt +++ b/docs/_sources/api.rst.txt @@ -2,6 +2,6 @@ plopm Python API ================ -The main script (and the only one by now) for the **plopm** executable is located in the `core `_ folder. +The main script (and the only one by now) for the **plopm** executable is located in the `core `_ folder. .. include:: modules.rst \ No newline at end of file diff --git a/docs/_sources/introduction.rst.txt b/docs/_sources/introduction.rst.txt index 9852b33..72d70b6 100644 --- a/docs/_sources/introduction.rst.txt +++ b/docs/_sources/introduction.rst.txt @@ -28,7 +28,7 @@ The current implementation supports the following executable with the argument o .. code-block:: bash - pycopm -i some_input -o some_output_folder + plopm -i some_input -o some_output_folder where @@ -42,14 +42,14 @@ where Installation ------------ -See the `Github page `_. +See the `Github page `_. .. tip:: - Check the `CI.yml `_ file. + Check the `CI.yml `_ file. Getting started --------------- See the :doc:`examples <./examples>`. .. tip:: - Check the `tests `_. \ No newline at end of file + Check the `tests `_. \ No newline at end of file diff --git a/docs/api.html b/docs/api.html index c82fe57..9e72c40 100644 --- a/docs/api.html +++ b/docs/api.html @@ -86,7 +86,7 @@

plopm Python API

-

The main script (and the only one by now) for the plopm executable is located in the core folder.

+

The main script (and the only one by now) for the plopm executable is located in the core folder.

plopm

diff --git a/docs/introduction.html b/docs/introduction.html index 25244f8..876edae 100644 --- a/docs/introduction.html +++ b/docs/introduction.html @@ -103,7 +103,7 @@

Concept

Overview

The current implementation supports the following executable with the argument options:

-
pycopm -i some_input -o some_output_folder
+
plopm -i some_input -o some_output_folder
 

 

 
where

@@ -119,10 +119,10 @@ 
Concept

Installation

-

See the Github page.

+

See the Github page.

Tip

-

Check the CI.yml file.

+

Check the CI.yml file.

@@ -130,7 +130,7 @@

Getting startedexamples.

Tip

-

Check the tests.

+

Check the tests.

diff --git a/docs/searchindex.js b/docs/searchindex.js index 6d07f23..5217252 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"About plopm": [[0, "about-plopm"]], "Concept": [[4, "concept"]], "Examples": [[2, "examples"]], "Generic deck": [[2, "generic-deck"]], "Getting started": [[4, "getting-started"]], "Indices and tables": [[3, "indices-and-tables"]], "Installation": [[4, "installation"]], "Introduction": [[4, "introduction"]], "Module contents": [[6, "module-plopm"], [7, "module-plopm.core"]], "Norne": [[2, "norne"]], "Overview": [[4, "overview"]], "Related": [[9, "related"]], "SPE11B": [[2, "spe11b"]], "Submodules": [[7, "submodules"]], "Subpackages": [[6, "subpackages"]], "Welcome to plopm\u2019s documentation!": [[3, "welcome-to-plopm-s-documentation"]], "ad-micp": [[9, "ad-micp"]], "expreccs": [[9, "expreccs"]], "plopm": [[1, "plopm"], [5, "plopm"]], "plopm Python API": [[1, "plopm-python-api"]], "plopm package": [[6, "plopm-package"]], "plopm.core package": [[7, "plopm-core-package"]], "plopm.core.plopm module": [[8, "module-plopm.core.plopm"]], "pycopm": [[9, "pycopm"]], "pymm": [[9, "pymm"]], "pyopmnearwell": [[9, "pyopmnearwell"]], "pyopmspe11": [[9, "pyopmspe11"]]}, "docnames": ["about", "api", "examples", "index", "introduction", "modules", "plopm", "plopm.core", "plopm.core.plopm", "related"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.rst", "api.rst", "examples.rst", "index.rst", "introduction.rst", "modules.rst", "plopm.rst", "plopm.core.rst", "plopm.core.plopm.rst", "related.rst"], "indexentries": {"get_kws() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_kws", false]], "get_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_wells", false]], "get_xy_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xy_wells", false]], "get_xycoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xycoords", false]], "get_xzcoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xzcoords", false]], "get_yzcoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_yzcoords", false]], "load_parser() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.load_parser", false]], "main() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.main", false]], "make_2dmaps() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.make_2dmaps", false]], "make_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.make_wells", false]], "module": [[6, "module-plopm", false], [7, "module-plopm.core", false], [8, "module-plopm.core.plopm", false]], "plopm": [[6, "module-plopm", false]], "plopm() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.plopm", false]], "plopm.core": [[7, "module-plopm.core", false]], "plopm.core.plopm": [[8, "module-plopm.core.plopm", false]]}, "objects": {"": [[6, 0, 0, "-", "plopm"]], "plopm": [[7, 0, 0, "-", "core"]], "plopm.core": [[8, 0, 0, "-", "plopm"]], "plopm.core.plopm": [[8, 1, 1, "", "get_kws"], [8, 1, 1, "", "get_wells"], [8, 1, 1, "", "get_xy_wells"], [8, 1, 1, "", "get_xycoords"], [8, 1, 1, "", "get_xzcoords"], [8, 1, 1, "", "get_yzcoords"], [8, 1, 1, "", "load_parser"], [8, 1, 1, "", "main"], [8, 1, 1, "", "make_2dmaps"], [8, 1, 1, "", "make_wells"], [8, 1, 1, "", "plopm"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": [2, 4], "0": [2, 4], "1": [2, 4], "10": 4, "14": [2, 4], "2d": [4, 8], "331841": 0, "455600": 2, "462200": 2, "50": 2, "7319500": 2, "7327100": 2, "A": 9, "If": 8, "The": [0, 1, 2, 4], "Then": 2, "about": 3, "activ": 2, "ad": 3, "add": 2, "addit": 4, "all": 4, "along": 4, "an": [2, 9], "ani": [4, 8], "api": 3, "approach": [0, 4], "ar": [0, 2, 8, 9], "arg": 8, "argument": [2, 4, 8], "axi": [2, 4], "base": [4, 9], "being": 0, "below": 9, "benchmark": 9, "bound": 4, "calcit": 9, "can": 4, "cell": [2, 4], "center": 0, "cfd": 9, "check": [4, 9], "ci": 4, "co2": 9, "coarsen": 9, "concept": 3, "configur": 2, "content": [1, 3, 4, 5], "contribut": 0, "coordin": 8, "core": [1, 5, 6], "could": 4, "creat": 8, "csp": 9, "cssr": 0, "current": 4, "data": [2, 8], "deck": [3, 4, 8], "default": [2, 4], "definit": 2, "describ": 4, "dic": 8, "dict": 8, "dictionari": 8, "document": 4, "download": 2, "dynam": [4, 9], "e": 4, "easili": 4, "exampl": [3, 4], "execut": [1, 4, 8], "expans": 9, "exprecc": 3, "extend": 4, "extens": 4, "f": [2, 4], "figur": [2, 4, 8], "file": [2, 4, 8], "flexibl": [4, 9], "flow": [0, 2, 4, 8, 9], "fluid": 4, "folder": [1, 2, 4], "follow": [2, 4], "font": 4, "fork": 0, "framework": [4, 9], "from": [2, 4, 8], "function": 8, "fund": 0, "g": 4, "gener": [3, 4], "geolog": [0, 4, 8, 9], "get": [3, 8], "get_kw": [6, 7, 8], "get_wel": [6, 7, 8], "get_xy_wel": [6, 7, 8], "get_xycoord": [6, 7, 8], "get_xzcoord": [6, 7, 8], "get_yzcoord": [6, 7, 8], "github": 4, "given": 4, "global": 8, "grid": 8, "h": 2, "here": 2, "horda": 9, "i": [0, 1, 2, 4, 8], "imag": 9, "implement": 4, "index": 3, "induc": 9, "init": 8, "input": [2, 4, 8], "insid": 2, "inspect": 4, "instal": [2, 3], "interest": 9, "introduct": 3, "j": [4, 8], "k": 2, "leakag": 9, "load_pars": [6, 7, 8], "locat": [1, 2, 8], "lower": 4, "main": [1, 4, 6, 7, 8], "make_2dmap": [6, 7, 8], "make_wel": [6, 7, 8], "map": [4, 8], "mesh": 8, "method": 8, "micp": 3, "microbi": 9, "microsystem": 9, "middl": 4, "might": 9, "model": [0, 2, 4, 8, 9], "modifi": 8, "modul": [1, 3, 5, 9], "more": 0, "name": 4, "nice": 4, "norn": 3, "norne_atw2013": 2, "now": [1, 4], "number": 4, "o": [2, 4], "one": 1, "onli": [1, 8], "open": 9, "opm": [0, 2, 4, 8, 9], "option": [2, 4, 8], "order": 2, "out": 9, "output": [2, 4], "outsid": 2, "overview": [2, 3], "packag": [1, 3, 5], "page": [3, 4], "paper": 4, "part": 4, "pcolormesh": 8, "permeabl": 4, "place": 4, "plane": 4, "platform": 9, "plopm": [2, 4], "plot": [0, 2, 4, 8], "png": 4, "pore": 4, "poros": 4, "precipit": 9, "present": 4, "progress": [0, 4], "project": [0, 9], "properti": [4, 8], "pull": 0, "py": 2, "pycopm": [3, 4], "pymm": 3, "pyopmnearwel": 3, "pyopmspe11": [2, 3], "python": [3, 9], "quick": 4, "read": 8, "reduc": 2, "relat": 3, "reli": 2, "remedi": 9, "request": 0, "resdatafil": 8, "reservoir": 4, "resourc": [0, 9], "result": 2, "return": 8, "run": 2, "same": 2, "satur": 4, "scale": 4, "script": [1, 4, 8], "search": 3, "see": [2, 4], "set": [2, 4], "should": 2, "simplifi": [4, 9], "simul": [2, 9], "size": 4, "slide": 4, "some": [2, 9], "some_input": 4, "some_output_fold": 4, "sourc": 9, "space": 2, "spe10_model2": 2, "spe11": 9, "spe11b": [3, 4], "start": 3, "static": [4, 8], "storag": 9, "studi": 9, "submodul": [1, 5, 6], "subpackag": [1, 3, 5], "subsurfac": 0, "succe": 2, "support": 4, "surfac": 4, "sustain": 0, "termin": 2, "test": [2, 4], "test_generic_deck": 2, "than": 0, "them": [8, 9], "thi": [0, 2, 4], "tool": [0, 2, 4, 9], "top": [2, 8], "type": 2, "upper": 4, "us": [0, 2, 4, 8, 9], "variabl": 4, "view": [2, 8], "visual": 4, "volum": 4, "we": [2, 8], "welcom": 0, "well": [4, 8, 9], "were": 2, "where": [2, 4], "white": 2, "work": [0, 4], "x": [2, 4, 8], "xlim": 2, "xy": [2, 4, 8], "xz": [4, 8], "y": [2, 4, 8], "ye": 4, "ylim": 2, "yml": 4, "you": [2, 4], "yz": 8, "z": 4}, "titles": ["About plopm", "plopm Python API", "Examples", "Welcome to plopm\u2019s documentation!", "Introduction", "plopm", "plopm package", "plopm.core package", "plopm.core.plopm module", "Related"], "titleterms": {"": 3, "about": 0, "ad": 9, "api": 1, "concept": 4, "content": [6, 7], "core": [7, 8], "deck": 2, "document": 3, "exampl": 2, "exprecc": 9, "gener": 2, "get": 4, "indic": 3, "instal": 4, "introduct": 4, "micp": 9, "modul": [6, 7, 8], "norn": 2, "overview": 4, "packag": [6, 7], "plopm": [0, 1, 3, 5, 6, 7, 8], "pycopm": 9, "pymm": 9, "pyopmnearwel": 9, "pyopmspe11": 9, "python": 1, "relat": 9, "spe11b": 2, "start": 4, "submodul": 7, "subpackag": 6, "tabl": 3, "welcom": 3}}) \ No newline at end of file +Search.setIndex({"alltitles": {"About plopm": [[0, "about-plopm"]], "Concept": [[4, "concept"]], "Examples": [[2, "examples"]], "Generic deck": [[2, "generic-deck"]], "Getting started": [[4, "getting-started"]], "Indices and tables": [[3, "indices-and-tables"]], "Installation": [[4, "installation"]], "Introduction": [[4, "introduction"]], "Module contents": [[6, "module-plopm"], [7, "module-plopm.core"]], "Norne": [[2, "norne"]], "Overview": [[4, "overview"]], "Related": [[9, "related"]], "SPE11B": [[2, "spe11b"]], "Submodules": [[7, "submodules"]], "Subpackages": [[6, "subpackages"]], "Welcome to plopm\u2019s documentation!": [[3, "welcome-to-plopm-s-documentation"]], "ad-micp": [[9, "ad-micp"]], "expreccs": [[9, "expreccs"]], "plopm": [[1, "plopm"], [5, "plopm"]], "plopm Python API": [[1, "plopm-python-api"]], "plopm package": [[6, "plopm-package"]], "plopm.core package": [[7, "plopm-core-package"]], "plopm.core.plopm module": [[8, "module-plopm.core.plopm"]], "pycopm": [[9, "pycopm"]], "pymm": [[9, "pymm"]], "pyopmnearwell": [[9, "pyopmnearwell"]], "pyopmspe11": [[9, "pyopmspe11"]]}, "docnames": ["about", "api", "examples", "index", "introduction", "modules", "plopm", "plopm.core", "plopm.core.plopm", "related"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.rst", "api.rst", "examples.rst", "index.rst", "introduction.rst", "modules.rst", "plopm.rst", "plopm.core.rst", "plopm.core.plopm.rst", "related.rst"], "indexentries": {"get_kws() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_kws", false]], "get_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_wells", false]], "get_xy_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xy_wells", false]], "get_xycoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xycoords", false]], "get_xzcoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_xzcoords", false]], "get_yzcoords() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.get_yzcoords", false]], "load_parser() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.load_parser", false]], "main() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.main", false]], "make_2dmaps() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.make_2dmaps", false]], "make_wells() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.make_wells", false]], "module": [[6, "module-plopm", false], [7, "module-plopm.core", false], [8, "module-plopm.core.plopm", false]], "plopm": [[6, "module-plopm", false]], "plopm() (in module plopm.core.plopm)": [[8, "plopm.core.plopm.plopm", false]], "plopm.core": [[7, "module-plopm.core", false]], "plopm.core.plopm": [[8, "module-plopm.core.plopm", false]]}, "objects": {"": [[6, 0, 0, "-", "plopm"]], "plopm": [[7, 0, 0, "-", "core"]], "plopm.core": [[8, 0, 0, "-", "plopm"]], "plopm.core.plopm": [[8, 1, 1, "", "get_kws"], [8, 1, 1, "", "get_wells"], [8, 1, 1, "", "get_xy_wells"], [8, 1, 1, "", "get_xycoords"], [8, 1, 1, "", "get_xzcoords"], [8, 1, 1, "", "get_yzcoords"], [8, 1, 1, "", "load_parser"], [8, 1, 1, "", "main"], [8, 1, 1, "", "make_2dmaps"], [8, 1, 1, "", "make_wells"], [8, 1, 1, "", "plopm"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": [2, 4], "0": [2, 4], "1": [2, 4], "10": 4, "14": [2, 4], "2d": [4, 8], "331841": 0, "455600": 2, "462200": 2, "50": 2, "7319500": 2, "7327100": 2, "A": 9, "If": 8, "The": [0, 1, 2, 4], "Then": 2, "about": 3, "activ": 2, "ad": 3, "add": 2, "addit": 4, "all": 4, "along": 4, "an": [2, 9], "ani": [4, 8], "api": 3, "approach": [0, 4], "ar": [0, 2, 8, 9], "arg": 8, "argument": [2, 4, 8], "axi": [2, 4], "base": [4, 9], "being": 0, "below": 9, "benchmark": 9, "bound": 4, "calcit": 9, "can": 4, "cell": [2, 4], "center": 0, "cfd": 9, "check": [4, 9], "ci": 4, "co2": 9, "coarsen": 9, "concept": 3, "configur": 2, "content": [1, 3, 4, 5], "contribut": 0, "coordin": 8, "core": [1, 5, 6], "could": 4, "creat": 8, "csp": 9, "cssr": 0, "current": 4, "data": [2, 8], "deck": [3, 4, 8], "default": [2, 4], "definit": 2, "describ": 4, "dic": 8, "dict": 8, "dictionari": 8, "document": 4, "download": 2, "dynam": [4, 9], "e": 4, "easili": 4, "exampl": [3, 4], "execut": [1, 4, 8], "expans": 9, "exprecc": 3, "extend": 4, "extens": 4, "f": [2, 4], "figur": [2, 4, 8], "file": [2, 4, 8], "flexibl": [4, 9], "flow": [0, 2, 4, 8, 9], "fluid": 4, "folder": [1, 2, 4], "follow": [2, 4], "font": 4, "fork": 0, "framework": [4, 9], "from": [2, 4, 8], "function": 8, "fund": 0, "g": 4, "gener": [3, 4], "geolog": [0, 4, 8, 9], "get": [3, 8], "get_kw": [6, 7, 8], "get_wel": [6, 7, 8], "get_xy_wel": [6, 7, 8], "get_xycoord": [6, 7, 8], "get_xzcoord": [6, 7, 8], "get_yzcoord": [6, 7, 8], "github": 4, "given": 4, "global": 8, "grid": 8, "h": 2, "here": 2, "horda": 9, "i": [0, 1, 2, 4, 8], "imag": 9, "implement": 4, "index": 3, "induc": 9, "init": 8, "input": [2, 4, 8], "insid": 2, "inspect": 4, "instal": [2, 3], "interest": 9, "introduct": 3, "j": [4, 8], "k": 2, "leakag": 9, "load_pars": [6, 7, 8], "locat": [1, 2, 8], "lower": 4, "main": [1, 4, 6, 7, 8], "make_2dmap": [6, 7, 8], "make_wel": [6, 7, 8], "map": [4, 8], "mesh": 8, "method": 8, "micp": 3, "microbi": 9, "microsystem": 9, "middl": 4, "might": 9, "model": [0, 2, 4, 8, 9], "modifi": 8, "modul": [1, 3, 5, 9], "more": 0, "name": 4, "nice": 4, "norn": 3, "norne_atw2013": 2, "now": [1, 4], "number": 4, "o": [2, 4], "one": 1, "onli": [1, 8], "open": 9, "opm": [0, 2, 4, 8, 9], "option": [2, 4, 8], "order": 2, "out": 9, "output": [2, 4], "outsid": 2, "overview": [2, 3], "packag": [1, 3, 5], "page": [3, 4], "paper": 4, "part": 4, "pcolormesh": 8, "permeabl": 4, "place": 4, "plane": 4, "platform": 9, "plopm": [2, 4], "plot": [0, 2, 4, 8], "png": 4, "pore": 4, "poros": 4, "precipit": 9, "present": 4, "progress": [0, 4], "project": [0, 9], "properti": [4, 8], "pull": 0, "py": 2, "pycopm": 3, "pymm": 3, "pyopmnearwel": 3, "pyopmspe11": [2, 3], "python": [3, 9], "quick": 4, "read": 8, "reduc": 2, "relat": 3, "reli": 2, "remedi": 9, "request": 0, "resdatafil": 8, "reservoir": 4, "resourc": [0, 9], "result": 2, "return": 8, "run": 2, "same": 2, "satur": 4, "scale": 4, "script": [1, 4, 8], "search": 3, "see": [2, 4], "set": [2, 4], "should": 2, "simplifi": [4, 9], "simul": [2, 9], "size": 4, "slide": 4, "some": [2, 9], "some_input": 4, "some_output_fold": 4, "sourc": 9, "space": 2, "spe10_model2": 2, "spe11": 9, "spe11b": [3, 4], "start": 3, "static": [4, 8], "storag": 9, "studi": 9, "submodul": [1, 5, 6], "subpackag": [1, 3, 5], "subsurfac": 0, "succe": 2, "support": 4, "surfac": 4, "sustain": 0, "termin": 2, "test": [2, 4], "test_generic_deck": 2, "than": 0, "them": [8, 9], "thi": [0, 2, 4], "tool": [0, 2, 4, 9], "top": [2, 8], "type": 2, "upper": 4, "us": [0, 2, 4, 8, 9], "variabl": 4, "view": [2, 8], "visual": 4, "volum": 4, "we": [2, 8], "welcom": 0, "well": [4, 8, 9], "were": 2, "where": [2, 4], "white": 2, "work": [0, 4], "x": [2, 4, 8], "xlim": 2, "xy": [2, 4, 8], "xz": [4, 8], "y": [2, 4, 8], "ye": 4, "ylim": 2, "yml": 4, "you": [2, 4], "yz": 8, "z": 4}, "titles": ["About plopm", "plopm Python API", "Examples", "Welcome to plopm\u2019s documentation!", "Introduction", "plopm", "plopm package", "plopm.core package", "plopm.core.plopm module", "Related"], "titleterms": {"": 3, "about": 0, "ad": 9, "api": 1, "concept": 4, "content": [6, 7], "core": [7, 8], "deck": 2, "document": 3, "exampl": 2, "exprecc": 9, "gener": 2, "get": 4, "indic": 3, "instal": 4, "introduct": 4, "micp": 9, "modul": [6, 7, 8], "norn": 2, "overview": 4, "packag": [6, 7], "plopm": [0, 1, 3, 5, 6, 7, 8], "pycopm": 9, "pymm": 9, "pyopmnearwel": 9, "pyopmspe11": 9, "python": 1, "relat": 9, "spe11b": 2, "start": 4, "submodul": 7, "subpackag": 6, "tabl": 3, "welcom": 3}}) \ No newline at end of file diff --git a/docs/text/api.rst b/docs/text/api.rst index e0ca002..e2d407c 100644 --- a/docs/text/api.rst +++ b/docs/text/api.rst @@ -2,6 +2,6 @@ plopm Python API ================ -The main script (and the only one by now) for the **plopm** executable is located in the `core `_ folder. +The main script (and the only one by now) for the **plopm** executable is located in the `core `_ folder. .. include:: modules.rst \ No newline at end of file diff --git a/docs/text/introduction.rst b/docs/text/introduction.rst index 9852b33..72d70b6 100644 --- a/docs/text/introduction.rst +++ b/docs/text/introduction.rst @@ -28,7 +28,7 @@ The current implementation supports the following executable with the argument o .. code-block:: bash - pycopm -i some_input -o some_output_folder + plopm -i some_input -o some_output_folder where @@ -42,14 +42,14 @@ where Installation ------------ -See the `Github page `_. +See the `Github page `_. .. tip:: - Check the `CI.yml `_ file. + Check the `CI.yml `_ file. Getting started --------------- See the :doc:`examples <./examples>`. .. tip:: - Check the `tests `_. \ No newline at end of file + Check the `tests `_. \ No newline at end of file