From 975184b8fa58aba2141668110594efbfe787c8c5 Mon Sep 17 00:00:00 2001
From: Lachlan Grose <lachlan.grose@monash.edu>
Date: Wed, 31 Jan 2024 14:51:30 +1100
Subject: [PATCH] geological

---
 .buildinfo                                  |  2 +-
 _sources/API.rst                            | 10 +++
 _sources/index.rst                          | 94 +++++++++++++++++++++
 _sources/index.rst.txt                      |  2 +-
 _sources/user_guide/getting_started.rst.txt | 10 +--
 index.html                                  |  2 +-
 searchindex.js                              |  2 +-
 7 files changed, 109 insertions(+), 13 deletions(-)
 create mode 100644 _sources/API.rst
 create mode 100644 _sources/index.rst

diff --git a/.buildinfo b/.buildinfo
index fcdefebf..6b5eb92f 100644
--- a/.buildinfo
+++ b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bc5b970d010b44222d3e8f114e3fbe62
+config: 41df95f0b456467426b3a4993c4edb55
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/API.rst b/_sources/API.rst
new file mode 100644
index 00000000..1f15d9bf
--- /dev/null
+++ b/_sources/API.rst
@@ -0,0 +1,10 @@
+API
+---
+
+.. autosummary::
+   :caption: API
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   map2loop
diff --git a/_sources/index.rst b/_sources/index.rst
new file mode 100644
index 00000000..6dba8aae
--- /dev/null
+++ b/_sources/index.rst
@@ -0,0 +1,94 @@
+.. map2loop documentation master file, created by
+   sphinx-quickstart on Wed Jan 17 15:48:56 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Map2loop 3.0.x
+====================================
+
+Generate 3D geological model inputs from geological maps — a high-level implementation and extension of the original map2loop code developed by Prof. Mark Jessell at UWA. 
+To see an example interactive model built with map2loop and LoopStructural, follow this link:
+
+.. raw:: html
+   :file: http://tectonique.net/models/brockman_syncline.html
+
+
+
+Usage
+------
+
+Our notebooks cover use cases in more detail, but here is an example of processing Loop's South Australia remote geospatial data in just 20 lines of Python.
+
+First, lets import map2loop and define a bounding box. You can use GIS software to find one. Remember what projection your coordinates are in!
+
+.. code-block::
+
+   from map2loop.project import Project
+   from map2loop.m2l_enums import VerboseLevel
+
+   # Note that this region is defined in the EPSG 28354 projection and
+   # x and y represent easting and northing respectively
+   bbox_3d = {
+      'minx': 250805.1529856466,
+      'miny': 6405084.328058686,
+      'maxx': 336682.921539395,
+      'maxy': 6458336.085975628,
+      'base': -3200,
+      'top': 1200
+   }
+
+
+
+Then, specify: the state, directory for the output, the bounding box and projection from above - and hit go! That's it.
+
+.. code-block::
+
+   proj = Project(use_australian_state_data = "SA",
+                  working_projection = 'EPSG:28354',
+                  bounding_box = bbox_3d,
+                  loop_project_filename = "output.loop3d"
+                  )
+
+   proj.run_all()
+
+
+This is a minimal example and a small part of Loop.
+
+Our *documentation and other resources outline how to extend map2loop and port to the LoopStructural modelling engine. We are working to incorporate geophysical tools and best provide visualisation and workflow consolidation in the GUI.*
+
+*Loop is led by Laurent Ailleres (Monash University) with a team of Work Package leaders from:*
+
+- *Monash University: Roy Thomson, Lachlan Grose and Robin Armit*
+- *University of Western Australia: Mark Jessell, Jeremie Giraud, Mark Lindsay and Guillaume Pirot*
+- *Geological Survey of Canada: Boyan Brodaric and Eric de Kemp*
+
+
+
+Known Issues and FAQs
+~~~~~~~~~~~~~~~~~~~~~~~
+- Developing with docker on Windows means you won't have GPU passthrough and can’t use a discrete graphics card in the container even if you have one.
+- If Jupyter links require a token or password, it may mean port 8888 is already in use. To fix, either make docker map to another port on the host ie -p 8889:8888 or stop any other instances on 8888.
+
+Links
+~~~~~~
+
+`https://loop3d.github.io/ <https://loop3d.github.io/>`_
+
+`https://github.com/Loop3D/LoopStructural <https://github.com/Loop3D/LoopStructural>`_
+
+
+
+.. toctree::
+   :hidden:
+
+   user_guide/index
+   _auto_examples/index
+   CHANGLOG.md
+
+.. autosummary::
+   :caption: API
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   map2loop
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index a5ff9e9c..cb267834 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -6,7 +6,7 @@
 Map2loop 3.0.x
 ====================================
 
-Generate 3D geological model inputs from geographical maps — a high-level implementation and extension of the original map2loop code developed by Prof. Mark Jessell at UWA. To see an example interactive model built with map2loop and LoopStructural, follow this link:
+Generate 3D geological model inputs from geolocial maps — a high-level implementation and extension of the original map2loop code developed by Prof. Mark Jessell at UWA. To see an example interactive model built with map2loop and LoopStructural, follow this link:
 
 .. raw:: html
    :file: http://tectonique.net/models/brockman_syncline.html
diff --git a/_sources/user_guide/getting_started.rst.txt b/_sources/user_guide/getting_started.rst.txt
index 26cbe7cf..746ad84a 100644
--- a/_sources/user_guide/getting_started.rst.txt
+++ b/_sources/user_guide/getting_started.rst.txt
@@ -1,10 +1,2 @@
 Getting started
-===============
-
-h2
-~~
-
-h3
-
-.. code-block:
-    
\ No newline at end of file
+===============
\ No newline at end of file
diff --git a/index.html b/index.html
index cbe5dc93..94ed5c82 100644
--- a/index.html
+++ b/index.html
@@ -380,7 +380,7 @@
                   
   <section id="map2loop-3-0-x">
 <h1>Map2loop 3.0.x<a class="headerlink" href="#map2loop-3-0-x" title="Link to this heading">#</a></h1>
-<p>Generate 3D geological model inputs from geographical maps — a high-level implementation and extension of the original map2loop code developed by Prof. Mark Jessell at UWA. To see an example interactive model built with map2loop and LoopStructural, follow this link:</p>
+<p>Generate 3D geological model inputs from geolocial maps — a high-level implementation and extension of the original map2loop code developed by Prof. Mark Jessell at UWA. To see an example interactive model built with map2loop and LoopStructural, follow this link:</p>
 <section id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h2>
 <p>Our notebooks cover use cases in more detail, but here is an example of processing Loop’s South Australia remote geospatial data in just 20 lines of Python.</p>
diff --git a/searchindex.js b/searchindex.js
index b665fcac..55cd46f9 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["API", "_auto_examples/index", "_auto_examples/plot_hamersley", "_auto_examples/sg_execution_times", "_autosummary/map2loop", "_autosummary/map2loop.Project", "index", "sg_execution_times", "user_guide/explanation", "user_guide/exporting", "user_guide/fault_offset", "user_guide/geomodelling", "user_guide/getting_started", "user_guide/index", "user_guide/installation", "user_guide/stratigraphic_order", "user_guide/stratigraphic_thickness"], "filenames": ["API.rst", "_auto_examples/index.rst", "_auto_examples/plot_hamersley.rst", "_auto_examples/sg_execution_times.rst", "_autosummary/map2loop.rst", "_autosummary/map2loop.Project.rst", "index.rst", "sg_execution_times.rst", "user_guide/explanation.rst", "user_guide/exporting.rst", "user_guide/fault_offset.rst", "user_guide/geomodelling.rst", "user_guide/getting_started.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/stratigraphic_order.rst", "user_guide/stratigraphic_thickness.rst"], "titles": ["API", "Examples", "Hamersley, Western Australia", "Computation times", "map2loop", "map2loop.Project", "Map2loop 3.0.x", "Computation times", "What map2loop does", "Exporting", "Fault offset calculation", "Creating a 3D geological model", "Getting started", "User Guide", "Installing map2loop", "Identifying stratigraphic order", "Calculating stratigraphic thicknesses"], "terms": {"hamerslei": [1, 3, 7], "western": [1, 3, 6, 7], "australia": [1, 3, 6, 7], "download": [1, 2, 14], "all": [1, 2, 5, 7], "python": [1, 2, 6, 14], "sourc": [1, 2, 14], "code": [1, 2, 5, 6, 14], "_auto_examples_python": 1, "zip": [1, 5], "jupyt": [1, 2, 6, 14], "notebook": [1, 2, 6, 14], "_auto_examples_jupyt": 1, "galleri": [1, 2, 7], "gener": [1, 2, 6], "sphinx": [1, 2], "go": [2, 6], "end": 2, "full": [2, 5], "exampl": [2, 3, 6, 7, 14], "import": [2, 6], "time": 2, "o": 2, "from": [2, 3, 5, 6, 7], "m2l_enum": [2, 5, 6], "verboselevel": [2, 5, 6], "datatyp": [2, 5], "sorter": [2, 5], "sorteralpha": 2, "sorteragebas": 2, "sorterusehint": 2, "sorterusenetworkx": 2, "sortermaximisecontact": 2, "sorterobservationproject": 2, "sampler": [2, 5], "samplerspac": 2, "datetim": 2, "defin": [2, 5, 6], "bound": [2, 6], "box": [2, 6], "roi": [2, 6], "bbox_3d": [2, 6], "minx": [2, 6], "515687": 2, "31005864": 2, "mini": [2, 6], "7493446": 2, "76593407": 2, "maxx": [2, 6], "562666": 2, "860106543": 2, "maxi": [2, 6], "7521273": 2, "57407786": 2, "base": [2, 5, 6], "3200": [2, 6], "top": [2, 6], "3000": 2, "specifi": [2, 5, 6], "minimum": 2, "detail": [2, 6], "which": [2, 5], "australian": 2, "state": [2, 5, 6], "output": [2, 5, 6], "file": [2, 3, 5, 7, 14], "loop_project_filenam": [2, 5, 6], "wa_output": 2, "loop3d": [2, 6, 14], "proj": [2, 6], "use_australian_state_data": [2, 5, 6], "wa": [2, 5], "working_project": [2, 5, 6], "epsg": [2, 5, 6], "28350": 2, "bounding_box": [2, 5, 6], "verbose_level": [2, 5], "none": [2, 5], "distanc": 2, "between": 2, "sampl": [2, 5], "point": [2, 5], "arial": 2, "linestr": 2, "geometri": 2, "set_sampl": [2, 5], "geologi": [2, 5], "200": 2, "0": [2, 3, 7], "fault": [2, 5, 13], "choos": 2, "stratigraph": [2, 5, 13], "us": [2, 5, 6], "run_al": [2, 5, 6], "take_best": [2, 5], "flag": [2, 5], "run": [2, 5, 14], "them": 2, "set_sort": [2, 5], "true": 2, "unus": 2, "kei": 2, "legaci": [2, 5], "format": [2, 5], "msc": 2, "msn": 2, "mst": 2, "mtc": 2, "mscm": 2, "mcom": 2, "minf": 2, "fdipdir_flag": 2, "deposit_dist": 2, "best": [2, 6], "calcul": [2, 5, 13], "contact": [2, 5], "length": [2, 5], "286560": 2, "51738879026": 2, "cannot": 2, "thick": [2, 5, 13], "fortescue_group": 2, "bunjinah_form": 2, "boolgeeda_iron_form": 2, "woongarra_rhyolit": 2, "weeli_wolli_form": 2, "brockman_iron_form": 2, "wittenoom_form": 2, "marra_mamba_iron_form": 2, "turee_creek_group": 2, "map_data": [2, 5], "basal_contact": [2, 5], "plot": [2, 5], "ax": 2, "total": [2, 3, 7], "script": 2, "minut": 2, "19": [2, 3, 7], "460": [2, 3, 7], "second": 2, "plot_hamerslei": [2, 3, 7], "ipynb": 2, "py": [2, 3, 7], "00": [3, 7], "execut": [3, 7], "1": [3, 7], "_auto_exampl": 3, "mem": [3, 7], "mb": [3, 7], "class": [4, 5], "tmp_path": 5, "str": 5, "m2l_data_tmp": 5, "geology_filenam": 5, "structure_filenam": 5, "fault_filenam": 5, "fold_filenam": 5, "dtm_filenam": 5, "config_filenam": 5, "config_dictionari": 5, "dict": 5, "clut_filenam": 5, "clut_file_legaci": 5, "bool": 5, "fals": 5, "save_pre_checked_map_data": 5, "kwarg": 5, "object": 5, "The": 5, "main": 5, "entri": 5, "A": 5, "select": 5, "how": [5, 6], "much": 5, "consol": 5, "log": 5, "i": [5, 6], "list": 5, "extract": 5, "polyon": 5, "line": [5, 6], "segment": 5, "index": 5, "datayp": 5, "sort": 5, "algorithm": 5, "column": 5, "thickness_calcul": 5, "thicknesscalul": 5, "make": [5, 6], "unit": 5, "estim": 5, "loop_filenam": 5, "name": [5, 14], "loop": [5, 6], "thi": [5, 6, 14], "mapdata": 5, "structur": 5, "hold": 5, "map": [5, 6, 13], "dtm": 5, "data": [5, 6], "map2model": 5, "map2modelwrapp": 5, "wrapper": 5, "around": 5, "modul": 5, "adjac": 5, "stratigraphic_column": 5, "stratigraphiccolumn": 5, "inform": 5, "order": [5, 13], "deformation_histori": 5, "deformationhistori": 5, "structura": 5, "fold": 5, "interact": [5, 6], "initialis": 5, "param": 5, "sent": 5, "default": 5, "type": 5, "option": 5, "directori": [5, 6], "store": 5, "temporari": 5, "int": 5, "boundari": 5, "extent": 5, "m": 5, "whether": 5, "filenam": 5, "shapefil": 5, "fo": 5, "digit": 5, "terrain": 5, "configur": 5, "json": 5, "dictionari": 5, "version": 5, "colour": 5, "look": 5, "up": [5, 14], "tabl": 5, "indic": 5, "clut": 5, "save": 5, "befor": 5, "rais": 5, "typeerror": 5, "valueerror": 5, "4": 5, "6": 5, "tupl": 5, "sa": [5, 6], "qld": 5, "nsw": 5, "ta": 5, "vic": 5, "act": 5, "nt": 5, "__init__": 5, "paramet": 5, "method": 5, "apply_colour_to_unit": 5, "appli": 5, "calculate_stratigraphic_ord": 5, "relationship": 5, "ag": 5, "creat": [5, 13], "calculate_unit_thick": 5, "draw_geology_map": 5, "datafram": 5, "overlai": 5, "specif": 5, "panda": 5, "must": 5, "contain": [5, 6, 14], "x": 5, "y": [5, 6, 14], "layer": 5, "ar": [5, 6], "orient": 5, "extract_geology_contact": 5, "along": 5, "get_minimum_fault_length": 5, "float": 5, "get": [5, 13, 14], "cutoff": 5, "return": 5, "get_sampl": 5, "being": 5, "get_sort": 5, "get_thickness_calcul": 5, "get_throw_calcul": 5, "throw": 5, "user_defined_stratigraphic_column": 5, "process": [5, 6], "user": 5, "fed": 5, "overrid": 5, "sample_map_data": 5, "polylin": 5, "save_geotiff_rast": 5, "test": 5, "tif": 5, "pixel_s": 5, "25": 5, "geotiff": 5, "string": 5, "3857": 5, "work": [5, 6], "size": 5, "pixel": 5, "metr": 5, "save_into_projectfil": 5, "updat": 5, "save_mapdata_to_fil": 5, "save_path": 5, "extens": [5, 6], "shp": 5, "frame": 5, "csv": 5, "path": 5, "an": [5, 6, 14], "altern": 5, "geodatafram": 5, "set_default_sampl": 5, "function": 5, "set": 5, "reset": 5, "set_ignore_cod": 5, "ignor": 5, "set_minimum_fault_length": 5, "determin": 5, "set_thickness_calcul": 5, "thicknesscalcul": 5, "set_throw_calcul": 5, "throw_calcul": 5, "throwcalcul": 5, "valu": 5, "sort_stratigraphic_column": 5, "match": 5, "summarise_fault_data": 5, "summari": 5, "each": 5, "3d": [6, 13], "geolog": [6, 13], "model": [6, 13], "input": 6, "geograph": 6, "high": 6, "level": 6, "implement": 6, "origin": 6, "develop": [6, 13], "prof": 6, "mark": 6, "jessel": 6, "uwa": 6, "To": [6, 14], "see": [6, 14], "built": 6, "loopstructur": 6, "follow": [6, 14], "our": 6, "cover": 6, "case": 6, "more": 6, "here": [6, 14], "": 6, "south": 6, "remot": 6, "geospati": 6, "just": [6, 14], "20": 6, "first": 6, "let": 6, "you": [6, 14], "can": 6, "gi": 6, "softwar": [6, 14], "find": [6, 14], "one": 6, "rememb": 6, "what": 6, "project": 6, "your": 6, "coordin": 6, "note": 6, "region": 6, "28354": 6, "repres": 6, "east": 6, "north": 6, "respect": 6, "250805": 6, "1529856466": 6, "6405084": 6, "328058686": 6, "336682": 6, "921539395": 6, "6458336": 6, "085975628": 6, "1200": 6, "Then": 6, "abov": [6, 14], "hit": 6, "That": 6, "minim": 6, "small": 6, "part": 6, "document": 6, "other": 6, "resourc": 6, "outlin": 6, "extend": 6, "port": 6, "engin": 6, "we": [6, 14], "incorpor": 6, "geophys": 6, "tool": 6, "provid": 6, "visualis": 6, "workflow": 6, "consolid": 6, "gui": 6, "led": 6, "laurent": 6, "ailler": 6, "monash": 6, "univers": 6, "team": 6, "packag": [6, 14], "leader": 6, "thomson": 6, "lachlan": 6, "grose": 6, "robin": 6, "armit": 6, "jeremi": 6, "giraud": 6, "lindsai": 6, "guillaum": 6, "pirot": 6, "survei": 6, "canada": 6, "boyan": 6, "brodar": 6, "eric": 6, "de": 6, "kemp": 6, "docker": [6, 13], "window": 6, "mean": 6, "won": 6, "t": 6, "have": 6, "gpu": 6, "passthrough": 6, "discret": 6, "graphic": 6, "card": 6, "even": 6, "If": [6, 14], "requir": 6, "token": 6, "password": 6, "mai": 6, "8888": 6, "alreadi": 6, "fix": 6, "either": 6, "anoth": 6, "host": 6, "ie": 6, "p": [6, 14], "8889": 6, "stop": 6, "ani": 6, "instanc": 6, "http": [6, 14], "github": [6, 14], "io": 6, "start": 13, "instal": 13, "map2loop": 13, "build": 13, "identifi": 13, "offset": 13, "export": 13, "need": 14, "some": 14, "flavour": 14, "conda": 14, "manag": 14, "well": 14, "3": 14, "8": 14, "command": 14, "c": 14, "forg": 14, "want": 14, "tinker": 14, "yourself": 14, "contribut": 14, "clone": 14, "git": 14, "com": 14, "Or": 14, "navig": 14, "issu": 14, "its": 14, "depend": 14, "txt": 14, "pip": 14, "edit": 14, "environ": 14, "e": 14, "fair": 14, "warn": 14, "recommend": 14, "almost": 14, "everyon": 14, "With": 14, "great": 14, "power": 14, "come": 14, "setup": 14, "inconveni": 14, "ll": 14, "containeris": 14, "compos": 14, "cli": 14, "repo": 14, "insid": 14, "per": 14, "click": 14, "server": 14, "forward": 14, "link": 14, "access": 14, "hop": 14, "bash": 14, "shell": 14, "open": 14, "termin": 14, "id": 14, "exec": 14, "container_nameorid": 14, "probabl": 14, "map2loop_dev_1": 14}, "objects": {"": [[4, 0, 0, "-", "map2loop"]], "map2loop": [[5, 1, 1, "", "Project"]], "map2loop.Project": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "apply_colour_to_units"], [5, 2, 1, "", "calculate_stratigraphic_order"], [5, 2, 1, "", "calculate_unit_thicknesses"], [5, 2, 1, "", "draw_geology_map"], [5, 2, 1, "", "extract_geology_contacts"], [5, 2, 1, "", "get_minimum_fault_length"], [5, 2, 1, "", "get_sampler"], [5, 2, 1, "", "get_sorter"], [5, 2, 1, "", "get_thickness_calculator"], [5, 2, 1, "", "get_throw_calculator"], [5, 2, 1, "", "run_all"], [5, 2, 1, "", "sample_map_data"], [5, 2, 1, "", "save_geotiff_raster"], [5, 2, 1, "", "save_into_projectfile"], [5, 2, 1, "", "save_mapdata_to_files"], [5, 2, 1, "", "set_default_samplers"], [5, 2, 1, "", "set_ignore_codes"], [5, 2, 1, "", "set_minimum_fault_length"], [5, 2, 1, "", "set_sampler"], [5, 2, 1, "", "set_sorter"], [5, 2, 1, "", "set_thickness_calculator"], [5, 2, 1, "", "set_throw_calculator"], [5, 2, 1, "", "sort_stratigraphic_column"], [5, 2, 1, "", "summarise_fault_data"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"api": 0, "exampl": 1, "hamerslei": 2, "western": 2, "australia": 2, "set": 2, "region": 2, "interest": 2, "project": [2, 5], "visualis": 2, "map2loop": [2, 4, 5, 6, 8, 14], "result": 2, "comput": [3, 7], "time": [3, 7], "attiribut": 5, "3": 6, "0": 6, "x": 6, "usag": 6, "known": 6, "issu": 6, "faq": 6, "link": 6, "what": 8, "doe": 8, "export": 9, "geolog": [9, 11], "map": 9, "fault": 10, "offset": 10, "calcul": [10, 16], "creat": 11, "3d": 11, "model": 11, "get": 12, "start": 12, "user": 13, "guid": 13, "instal": 14, "develop": 14, "build": 14, "docker": 14, "identifi": 15, "stratigraph": [15, 16], "order": 15, "thick": 16}, "envversion": {"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, "sphinx": 60}, "alltitles": {"API": [[0, "api"]], "Examples": [[1, "examples"]], "Hamersley, Western Australia": [[2, "hamersley-western-australia"]], "Set the region of interest for the project": [[2, "set-the-region-of-interest-for-the-project"]], "Visualise the map2loop results": [[2, "visualise-the-map2loop-results"]], "Computation times": [[3, "computation-times"], [7, "computation-times"]], "map2loop": [[4, "module-map2loop"]], "map2loop.Project": [[5, "map2loop-project"]], "Attiributes": [[5, "attiributes"]], "Map2loop 3.0.x": [[6, "map2loop-3-0-x"]], "Usage": [[6, "usage"]], "Known Issues and FAQs": [[6, "known-issues-and-faqs"]], "Links": [[6, "links"]], "What map2loop does": [[8, "what-map2loop-does"]], "Exporting": [[9, "exporting"]], "Geological map": [[9, "geological-map"]], "Fault offset calculation": [[10, "fault-offset-calculation"]], "Creating a 3D geological model": [[11, "creating-a-3d-geological-model"]], "Getting started": [[12, "getting-started"]], "User Guide": [[13, "user-guide"], [13, null]], "Installing map2loop": [[14, "installing-map2loop"]], "Install": [[14, "install"]], "Development": [[14, "development"], [14, "id1"]], "Building with Docker": [[14, "building-with-docker"]], "Identifying stratigraphic order": [[15, "identifying-stratigraphic-order"]], "Calculating stratigraphic thicknesses": [[16, "calculating-stratigraphic-thicknesses"]]}, "indexentries": {"map2loop": [[4, "module-map2loop"]], "module": [[4, "module-map2loop"]], "project (class in map2loop)": [[5, "map2loop.Project"]], "__init__() (map2loop.project method)": [[5, "map2loop.Project.__init__"]], "apply_colour_to_units() (map2loop.project method)": [[5, "map2loop.Project.apply_colour_to_units"]], "calculate_stratigraphic_order() (map2loop.project method)": [[5, "map2loop.Project.calculate_stratigraphic_order"]], "calculate_unit_thicknesses() (map2loop.project method)": [[5, "map2loop.Project.calculate_unit_thicknesses"]], "draw_geology_map() (map2loop.project method)": [[5, "map2loop.Project.draw_geology_map"]], "extract_geology_contacts() (map2loop.project method)": [[5, "map2loop.Project.extract_geology_contacts"]], "get_minimum_fault_length() (map2loop.project method)": [[5, "map2loop.Project.get_minimum_fault_length"]], "get_sampler() (map2loop.project method)": [[5, "map2loop.Project.get_sampler"]], "get_sorter() (map2loop.project method)": [[5, "map2loop.Project.get_sorter"]], "get_thickness_calculator() (map2loop.project method)": [[5, "map2loop.Project.get_thickness_calculator"]], "get_throw_calculator() (map2loop.project method)": [[5, "map2loop.Project.get_throw_calculator"]], "run_all() (map2loop.project method)": [[5, "map2loop.Project.run_all"]], "sample_map_data() (map2loop.project method)": [[5, "map2loop.Project.sample_map_data"]], "save_geotiff_raster() (map2loop.project method)": [[5, "map2loop.Project.save_geotiff_raster"]], "save_into_projectfile() (map2loop.project method)": [[5, "map2loop.Project.save_into_projectfile"]], "save_mapdata_to_files() (map2loop.project method)": [[5, "map2loop.Project.save_mapdata_to_files"]], "set_default_samplers() (map2loop.project method)": [[5, "map2loop.Project.set_default_samplers"]], "set_ignore_codes() (map2loop.project method)": [[5, "map2loop.Project.set_ignore_codes"]], "set_minimum_fault_length() (map2loop.project method)": [[5, "map2loop.Project.set_minimum_fault_length"]], "set_sampler() (map2loop.project method)": [[5, "map2loop.Project.set_sampler"]], "set_sorter() (map2loop.project method)": [[5, "map2loop.Project.set_sorter"]], "set_thickness_calculator() (map2loop.project method)": [[5, "map2loop.Project.set_thickness_calculator"]], "set_throw_calculator() (map2loop.project method)": [[5, "map2loop.Project.set_throw_calculator"]], "sort_stratigraphic_column() (map2loop.project method)": [[5, "map2loop.Project.sort_stratigraphic_column"]], "summarise_fault_data() (map2loop.project method)": [[5, "map2loop.Project.summarise_fault_data"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["API", "_auto_examples/index", "_auto_examples/plot_hamersley", "_auto_examples/sg_execution_times", "_autosummary/map2loop", "_autosummary/map2loop.Project", "index", "sg_execution_times", "user_guide/explanation", "user_guide/exporting", "user_guide/fault_offset", "user_guide/geomodelling", "user_guide/getting_started", "user_guide/index", "user_guide/installation", "user_guide/stratigraphic_order", "user_guide/stratigraphic_thickness"], "filenames": ["API.rst", "_auto_examples/index.rst", "_auto_examples/plot_hamersley.rst", "_auto_examples/sg_execution_times.rst", "_autosummary/map2loop.rst", "_autosummary/map2loop.Project.rst", "index.rst", "sg_execution_times.rst", "user_guide/explanation.rst", "user_guide/exporting.rst", "user_guide/fault_offset.rst", "user_guide/geomodelling.rst", "user_guide/getting_started.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/stratigraphic_order.rst", "user_guide/stratigraphic_thickness.rst"], "titles": ["API", "Examples", "Hamersley, Western Australia", "Computation times", "map2loop", "map2loop.Project", "Map2loop 3.0.x", "Computation times", "What map2loop does", "Exporting", "Fault offset calculation", "Creating a 3D geological model", "Getting started", "User Guide", "Installing map2loop", "Identifying stratigraphic order", "Calculating stratigraphic thicknesses"], "terms": {"hamerslei": [1, 3, 7], "western": [1, 3, 6, 7], "australia": [1, 3, 6, 7], "download": [1, 2, 14], "all": [1, 2, 5, 7], "python": [1, 2, 6, 14], "sourc": [1, 2, 14], "code": [1, 2, 5, 6, 14], "_auto_examples_python": 1, "zip": [1, 5], "jupyt": [1, 2, 6, 14], "notebook": [1, 2, 6, 14], "_auto_examples_jupyt": 1, "galleri": [1, 2, 7], "gener": [1, 2, 6], "sphinx": [1, 2], "go": [2, 6], "end": 2, "full": [2, 5], "exampl": [2, 3, 6, 7, 14], "import": [2, 6], "time": 2, "o": 2, "from": [2, 3, 5, 6, 7], "m2l_enum": [2, 5, 6], "verboselevel": [2, 5, 6], "datatyp": [2, 5], "sorter": [2, 5], "sorteralpha": 2, "sorteragebas": 2, "sorterusehint": 2, "sorterusenetworkx": 2, "sortermaximisecontact": 2, "sorterobservationproject": 2, "sampler": [2, 5], "samplerspac": 2, "datetim": 2, "defin": [2, 5, 6], "bound": [2, 6], "box": [2, 6], "roi": [2, 6], "bbox_3d": [2, 6], "minx": [2, 6], "515687": 2, "31005864": 2, "mini": [2, 6], "7493446": 2, "76593407": 2, "maxx": [2, 6], "562666": 2, "860106543": 2, "maxi": [2, 6], "7521273": 2, "57407786": 2, "base": [2, 5, 6], "3200": [2, 6], "top": [2, 6], "3000": 2, "specifi": [2, 5, 6], "minimum": 2, "detail": [2, 6], "which": [2, 5], "australian": 2, "state": [2, 5, 6], "output": [2, 5, 6], "file": [2, 3, 5, 7, 14], "loop_project_filenam": [2, 5, 6], "wa_output": 2, "loop3d": [2, 6, 14], "proj": [2, 6], "use_australian_state_data": [2, 5, 6], "wa": [2, 5], "working_project": [2, 5, 6], "epsg": [2, 5, 6], "28350": 2, "bounding_box": [2, 5, 6], "verbose_level": [2, 5], "none": [2, 5], "distanc": 2, "between": 2, "sampl": [2, 5], "point": [2, 5], "arial": 2, "linestr": 2, "geometri": 2, "set_sampl": [2, 5], "geologi": [2, 5], "200": 2, "0": [2, 3, 7], "fault": [2, 5, 13], "choos": 2, "stratigraph": [2, 5, 13], "us": [2, 5, 6], "run_al": [2, 5, 6], "take_best": [2, 5], "flag": [2, 5], "run": [2, 5, 14], "them": 2, "set_sort": [2, 5], "true": 2, "unus": 2, "kei": 2, "legaci": [2, 5], "format": [2, 5], "msc": 2, "msn": 2, "mst": 2, "mtc": 2, "mscm": 2, "mcom": 2, "minf": 2, "fdipdir_flag": 2, "deposit_dist": 2, "best": [2, 6], "calcul": [2, 5, 13], "contact": [2, 5], "length": [2, 5], "286560": 2, "51738879026": 2, "cannot": 2, "thick": [2, 5, 13], "fortescue_group": 2, "bunjinah_form": 2, "boolgeeda_iron_form": 2, "woongarra_rhyolit": 2, "weeli_wolli_form": 2, "brockman_iron_form": 2, "wittenoom_form": 2, "marra_mamba_iron_form": 2, "turee_creek_group": 2, "map_data": [2, 5], "basal_contact": [2, 5], "plot": [2, 5], "ax": 2, "total": [2, 3, 7], "script": 2, "minut": 2, "19": [2, 3, 7], "460": [2, 3, 7], "second": 2, "plot_hamerslei": [2, 3, 7], "ipynb": 2, "py": [2, 3, 7], "00": [3, 7], "execut": [3, 7], "1": [3, 7], "_auto_exampl": 3, "mem": [3, 7], "mb": [3, 7], "class": [4, 5], "tmp_path": 5, "str": 5, "m2l_data_tmp": 5, "geology_filenam": 5, "structure_filenam": 5, "fault_filenam": 5, "fold_filenam": 5, "dtm_filenam": 5, "config_filenam": 5, "config_dictionari": 5, "dict": 5, "clut_filenam": 5, "clut_file_legaci": 5, "bool": 5, "fals": 5, "save_pre_checked_map_data": 5, "kwarg": 5, "object": 5, "The": 5, "main": 5, "entri": 5, "A": 5, "select": 5, "how": [5, 6], "much": 5, "consol": 5, "log": 5, "i": [5, 6], "list": 5, "extract": 5, "polyon": 5, "line": [5, 6], "segment": 5, "index": 5, "datayp": 5, "sort": 5, "algorithm": 5, "column": 5, "thickness_calcul": 5, "thicknesscalul": 5, "make": [5, 6], "unit": 5, "estim": 5, "loop_filenam": 5, "name": [5, 14], "loop": [5, 6], "thi": [5, 6, 14], "mapdata": 5, "structur": 5, "hold": 5, "map": [5, 6, 13], "dtm": 5, "data": [5, 6], "map2model": 5, "map2modelwrapp": 5, "wrapper": 5, "around": 5, "modul": 5, "adjac": 5, "stratigraphic_column": 5, "stratigraphiccolumn": 5, "inform": 5, "order": [5, 13], "deformation_histori": 5, "deformationhistori": 5, "structura": 5, "fold": 5, "interact": [5, 6], "initialis": 5, "param": 5, "sent": 5, "default": 5, "type": 5, "option": 5, "directori": [5, 6], "store": 5, "temporari": 5, "int": 5, "boundari": 5, "extent": 5, "m": 5, "whether": 5, "filenam": 5, "shapefil": 5, "fo": 5, "digit": 5, "terrain": 5, "configur": 5, "json": 5, "dictionari": 5, "version": 5, "colour": 5, "look": 5, "up": [5, 14], "tabl": 5, "indic": 5, "clut": 5, "save": 5, "befor": 5, "rais": 5, "typeerror": 5, "valueerror": 5, "4": 5, "6": 5, "tupl": 5, "sa": [5, 6], "qld": 5, "nsw": 5, "ta": 5, "vic": 5, "act": 5, "nt": 5, "__init__": 5, "paramet": 5, "method": 5, "apply_colour_to_unit": 5, "appli": 5, "calculate_stratigraphic_ord": 5, "relationship": 5, "ag": 5, "creat": [5, 13], "calculate_unit_thick": 5, "draw_geology_map": 5, "datafram": 5, "overlai": 5, "specif": 5, "panda": 5, "must": 5, "contain": [5, 6, 14], "x": 5, "y": [5, 6, 14], "layer": 5, "ar": [5, 6], "orient": 5, "extract_geology_contact": 5, "along": 5, "get_minimum_fault_length": 5, "float": 5, "get": [5, 13, 14], "cutoff": 5, "return": 5, "get_sampl": 5, "being": 5, "get_sort": 5, "get_thickness_calcul": 5, "get_throw_calcul": 5, "throw": 5, "user_defined_stratigraphic_column": 5, "process": [5, 6], "user": 5, "fed": 5, "overrid": 5, "sample_map_data": 5, "polylin": 5, "save_geotiff_rast": 5, "test": 5, "tif": 5, "pixel_s": 5, "25": 5, "geotiff": 5, "string": 5, "3857": 5, "work": [5, 6], "size": 5, "pixel": 5, "metr": 5, "save_into_projectfil": 5, "updat": 5, "save_mapdata_to_fil": 5, "save_path": 5, "extens": [5, 6], "shp": 5, "frame": 5, "csv": 5, "path": 5, "an": [5, 6, 14], "altern": 5, "geodatafram": 5, "set_default_sampl": 5, "function": 5, "set": 5, "reset": 5, "set_ignore_cod": 5, "ignor": 5, "set_minimum_fault_length": 5, "determin": 5, "set_thickness_calcul": 5, "thicknesscalcul": 5, "set_throw_calcul": 5, "throw_calcul": 5, "throwcalcul": 5, "valu": 5, "sort_stratigraphic_column": 5, "match": 5, "summarise_fault_data": 5, "summari": 5, "each": 5, "3d": [6, 13], "geolog": [6, 13], "model": [6, 13], "input": 6, "geograph": [], "high": 6, "level": 6, "implement": 6, "origin": 6, "develop": [6, 13], "prof": 6, "mark": 6, "jessel": 6, "uwa": 6, "To": [6, 14], "see": [6, 14], "built": 6, "loopstructur": 6, "follow": [6, 14], "our": 6, "cover": 6, "case": 6, "more": 6, "here": [6, 14], "": 6, "south": 6, "remot": 6, "geospati": 6, "just": [6, 14], "20": 6, "first": 6, "let": 6, "you": [6, 14], "can": 6, "gi": 6, "softwar": [6, 14], "find": [6, 14], "one": 6, "rememb": 6, "what": 6, "project": 6, "your": 6, "coordin": 6, "note": 6, "region": 6, "28354": 6, "repres": 6, "east": 6, "north": 6, "respect": 6, "250805": 6, "1529856466": 6, "6405084": 6, "328058686": 6, "336682": 6, "921539395": 6, "6458336": 6, "085975628": 6, "1200": 6, "Then": 6, "abov": [6, 14], "hit": 6, "That": 6, "minim": 6, "small": 6, "part": 6, "document": 6, "other": 6, "resourc": 6, "outlin": 6, "extend": 6, "port": 6, "engin": 6, "we": [6, 14], "incorpor": 6, "geophys": 6, "tool": 6, "provid": 6, "visualis": 6, "workflow": 6, "consolid": 6, "gui": 6, "led": 6, "laurent": 6, "ailler": 6, "monash": 6, "univers": 6, "team": 6, "packag": [6, 14], "leader": 6, "thomson": 6, "lachlan": 6, "grose": 6, "robin": 6, "armit": 6, "jeremi": 6, "giraud": 6, "lindsai": 6, "guillaum": 6, "pirot": 6, "survei": 6, "canada": 6, "boyan": 6, "brodar": 6, "eric": 6, "de": 6, "kemp": 6, "docker": [6, 13], "window": 6, "mean": 6, "won": 6, "t": 6, "have": 6, "gpu": 6, "passthrough": 6, "discret": 6, "graphic": 6, "card": 6, "even": 6, "If": [6, 14], "requir": 6, "token": 6, "password": 6, "mai": 6, "8888": 6, "alreadi": 6, "fix": 6, "either": 6, "anoth": 6, "host": 6, "ie": 6, "p": [6, 14], "8889": 6, "stop": 6, "ani": 6, "instanc": 6, "http": [6, 14], "github": [6, 14], "io": 6, "start": 13, "instal": 13, "map2loop": 13, "build": 13, "identifi": 13, "offset": 13, "export": 13, "need": 14, "some": 14, "flavour": 14, "conda": 14, "manag": 14, "well": 14, "3": 14, "8": 14, "command": 14, "c": 14, "forg": 14, "want": 14, "tinker": 14, "yourself": 14, "contribut": 14, "clone": 14, "git": 14, "com": 14, "Or": 14, "navig": 14, "issu": 14, "its": 14, "depend": 14, "txt": 14, "pip": 14, "edit": 14, "environ": 14, "e": 14, "fair": 14, "warn": 14, "recommend": 14, "almost": 14, "everyon": 14, "With": 14, "great": 14, "power": 14, "come": 14, "setup": 14, "inconveni": 14, "ll": 14, "containeris": 14, "compos": 14, "cli": 14, "repo": 14, "insid": 14, "per": 14, "click": 14, "server": 14, "forward": 14, "link": 14, "access": 14, "hop": 14, "bash": 14, "shell": 14, "open": 14, "termin": 14, "id": 14, "exec": 14, "container_nameorid": 14, "probabl": 14, "map2loop_dev_1": 14, "geoloci": 6}, "objects": {"": [[4, 0, 0, "-", "map2loop"]], "map2loop": [[5, 1, 1, "", "Project"]], "map2loop.Project": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "apply_colour_to_units"], [5, 2, 1, "", "calculate_stratigraphic_order"], [5, 2, 1, "", "calculate_unit_thicknesses"], [5, 2, 1, "", "draw_geology_map"], [5, 2, 1, "", "extract_geology_contacts"], [5, 2, 1, "", "get_minimum_fault_length"], [5, 2, 1, "", "get_sampler"], [5, 2, 1, "", "get_sorter"], [5, 2, 1, "", "get_thickness_calculator"], [5, 2, 1, "", "get_throw_calculator"], [5, 2, 1, "", "run_all"], [5, 2, 1, "", "sample_map_data"], [5, 2, 1, "", "save_geotiff_raster"], [5, 2, 1, "", "save_into_projectfile"], [5, 2, 1, "", "save_mapdata_to_files"], [5, 2, 1, "", "set_default_samplers"], [5, 2, 1, "", "set_ignore_codes"], [5, 2, 1, "", "set_minimum_fault_length"], [5, 2, 1, "", "set_sampler"], [5, 2, 1, "", "set_sorter"], [5, 2, 1, "", "set_thickness_calculator"], [5, 2, 1, "", "set_throw_calculator"], [5, 2, 1, "", "sort_stratigraphic_column"], [5, 2, 1, "", "summarise_fault_data"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"api": 0, "exampl": 1, "hamerslei": 2, "western": 2, "australia": 2, "set": 2, "region": 2, "interest": 2, "project": [2, 5], "visualis": 2, "map2loop": [2, 4, 5, 6, 8, 14], "result": 2, "comput": [3, 7], "time": [3, 7], "attiribut": 5, "3": 6, "0": 6, "x": 6, "usag": 6, "known": 6, "issu": 6, "faq": 6, "link": 6, "what": 8, "doe": 8, "export": 9, "geolog": [9, 11], "map": 9, "fault": 10, "offset": 10, "calcul": [10, 16], "creat": 11, "3d": 11, "model": 11, "get": 12, "start": 12, "user": 13, "guid": 13, "instal": 14, "develop": 14, "build": 14, "docker": 14, "identifi": 15, "stratigraph": [15, 16], "order": 15, "thick": 16}, "envversion": {"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, "sphinx": 60}, "alltitles": {"API": [[0, "api"]], "Examples": [[1, "examples"]], "Hamersley, Western Australia": [[2, "hamersley-western-australia"]], "Set the region of interest for the project": [[2, "set-the-region-of-interest-for-the-project"]], "Visualise the map2loop results": [[2, "visualise-the-map2loop-results"]], "Computation times": [[3, "computation-times"], [7, "computation-times"]], "map2loop": [[4, "module-map2loop"]], "map2loop.Project": [[5, "map2loop-project"]], "Attiributes": [[5, "attiributes"]], "What map2loop does": [[8, "what-map2loop-does"]], "Exporting": [[9, "exporting"]], "Geological map": [[9, "geological-map"]], "Fault offset calculation": [[10, "fault-offset-calculation"]], "Creating a 3D geological model": [[11, "creating-a-3d-geological-model"]], "Getting started": [[12, "getting-started"]], "User Guide": [[13, "user-guide"], [13, null]], "Installing map2loop": [[14, "installing-map2loop"]], "Install": [[14, "install"]], "Development": [[14, "development"], [14, "id1"]], "Building with Docker": [[14, "building-with-docker"]], "Identifying stratigraphic order": [[15, "identifying-stratigraphic-order"]], "Calculating stratigraphic thicknesses": [[16, "calculating-stratigraphic-thicknesses"]], "Map2loop 3.0.x": [[6, "map2loop-3-0-x"]], "Usage": [[6, "usage"]], "Known Issues and FAQs": [[6, "known-issues-and-faqs"]], "Links": [[6, "links"]]}, "indexentries": {"map2loop": [[4, "module-map2loop"]], "module": [[4, "module-map2loop"]], "project (class in map2loop)": [[5, "map2loop.Project"]], "__init__() (map2loop.project method)": [[5, "map2loop.Project.__init__"]], "apply_colour_to_units() (map2loop.project method)": [[5, "map2loop.Project.apply_colour_to_units"]], "calculate_stratigraphic_order() (map2loop.project method)": [[5, "map2loop.Project.calculate_stratigraphic_order"]], "calculate_unit_thicknesses() (map2loop.project method)": [[5, "map2loop.Project.calculate_unit_thicknesses"]], "draw_geology_map() (map2loop.project method)": [[5, "map2loop.Project.draw_geology_map"]], "extract_geology_contacts() (map2loop.project method)": [[5, "map2loop.Project.extract_geology_contacts"]], "get_minimum_fault_length() (map2loop.project method)": [[5, "map2loop.Project.get_minimum_fault_length"]], "get_sampler() (map2loop.project method)": [[5, "map2loop.Project.get_sampler"]], "get_sorter() (map2loop.project method)": [[5, "map2loop.Project.get_sorter"]], "get_thickness_calculator() (map2loop.project method)": [[5, "map2loop.Project.get_thickness_calculator"]], "get_throw_calculator() (map2loop.project method)": [[5, "map2loop.Project.get_throw_calculator"]], "run_all() (map2loop.project method)": [[5, "map2loop.Project.run_all"]], "sample_map_data() (map2loop.project method)": [[5, "map2loop.Project.sample_map_data"]], "save_geotiff_raster() (map2loop.project method)": [[5, "map2loop.Project.save_geotiff_raster"]], "save_into_projectfile() (map2loop.project method)": [[5, "map2loop.Project.save_into_projectfile"]], "save_mapdata_to_files() (map2loop.project method)": [[5, "map2loop.Project.save_mapdata_to_files"]], "set_default_samplers() (map2loop.project method)": [[5, "map2loop.Project.set_default_samplers"]], "set_ignore_codes() (map2loop.project method)": [[5, "map2loop.Project.set_ignore_codes"]], "set_minimum_fault_length() (map2loop.project method)": [[5, "map2loop.Project.set_minimum_fault_length"]], "set_sampler() (map2loop.project method)": [[5, "map2loop.Project.set_sampler"]], "set_sorter() (map2loop.project method)": [[5, "map2loop.Project.set_sorter"]], "set_thickness_calculator() (map2loop.project method)": [[5, "map2loop.Project.set_thickness_calculator"]], "set_throw_calculator() (map2loop.project method)": [[5, "map2loop.Project.set_throw_calculator"]], "sort_stratigraphic_column() (map2loop.project method)": [[5, "map2loop.Project.sort_stratigraphic_column"]], "summarise_fault_data() (map2loop.project method)": [[5, "map2loop.Project.summarise_fault_data"]]}})
\ No newline at end of file