.. map2loop documentation master file, created by
   sphinx-quickstart on Tue Dec 21 16:23:02 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

map2loop documentation
====================================
map2loop is a map deconstruction library to provide inputs to Loop ([Loop3d.org](https://loop3d.org/)). 
The development of map2loop is lead by **Mark Jessell** at The University of Western Australia. **Roy Thomson** at Monash University is now making it better. Standalone map2model cpp code from Vitaliy provides fault/fault and fault/strat relationships.   

.. image:: pics/all_sm.png
  :width: 600
  :alt: summary



1. What it does:
################

-  Combines information extracted from vector geology maps in various forms to support 3D geological modelling. 
-  To find out how this is achieved, read the article in  `Geoscientific Model Development <https://gmd.copernicus.org/articles/14/5063/2021/>`_

Outputs are simple csv files that should be readable by any 3D modelling system (I think), but specific examples are provided for    

- https://github.com/Loop3D/LoopStructural LoopStructural,    
 
   
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

- This is very much a proof of concept code that is unlikely to work first time with anything but the example dataset provided, but if you would like to try it with your own data please feel free to contact me at mark.jessell@uwa.edu.au to discuss your plans.  
- The fastest install path is via conda, with instructions and code:
       
  http://github.com/Loop3D/map2loop-2    
   
The map2loop library uses the Geopandas library to load data from several persistent formats (ESRI shapefiles, 
MapInfo tab files, JavaScript Object Notation (JSON) format files) and or from a Web Feature Service (WFS). 
Geospatial data can be in any standard coordinate reference system (assuming a European Petroleum Survey Group 
(EPSG) code is supplied, http://epsg.io). These libraries are used to load and transform the input geological 
geometries and attributes. 


   
- Problems

Any bugs/feature requests/comments please create a new issue: https://github.com/Loop3D/map2loop-2/issues. 

- Acknowledgements

  * ARC Linkage Project LP1701000985   
  * MinEx CRC   

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. toctree::

   usage
   inputs
   outputs
   configuring_map2loop


.. toctree::
   :caption: map2loop code

   config
   project
   Geophysics
   map
   map2graph
   m2l_geometry
   m2l_export
   m2l_interpolation
   m2l_map_checker
   m2l_utils
   SpaceTime
   topology