Metadata-Version: 2.1
Name: map2loop
Version: 1.0.2
Summary: Generate 3D model data using 2D maps.
Home-page: https://github.com/Loop3D/map2loop-2
Author: Yohan de Rose
Author-email: contact@loop3d.org
License: UNKNOWN
Description: # Map2Loop 2.0
        
        Generate model input data from geological maps. Revision of objectives in [https://github.com/Loop3D/map2loop](https://github.com/Loop3D/map2loop)
        
        ## Dependencies
        
        If you wish to, create your own python virtual environment with the following modules to run the map2loop examples.
        
        - python=3.7
        - numpy
        - pandas
        - geopandas
        - matplotlib
        - rasterio
        - networkx
        - owslib
        - pyamg
        - descartes
        - mplstereonet
        
        ## Build with Docker
        
        Download and install the docker containerisation software and CLI [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
        
        ### Usage
        
        If you do not wish to develop map2loop, you can simply pull the complete docker image with map2loop and LoopStructural preinstalled, and run the container to interact with the notebooks.
        
        ```bash
        docker pull yohanderose/map2loop-2_dev:dev
        docker run -it -p 8888:8888 yohanderose/map2loop-2_dev:dev
        ```
        
        ### Development
        
        1. Clone this repo and navigate inside using the recurse submodules flag to fetch the example data.
        
           ```bash
           git clone --recurse-submodules https://github.com/Loop3D/map2loop-2
           ```
        
        2. Run the following command and click on the link Jupyter outputs to access the original [map2loop](https://github.com/Loop3D/map2loop) notebooks.
        
           ```bash
           docker-compose up
           ```
        
        3. To jump into a bash shell in the container itself, open a new terminal and issue the following command.
        
           ```bash
           docker exec -it map2loop-2_dev_1 bash
           ```
        
        ## Install via PyPi and Conda
        
        Still to come...
        
        ### Known Issues
        
        - Developing using docker on a Windows host will mean you will not have GPU passthrough functionality - so can't use a discrete graphics card in the container even if you have one.
        - If Jupyter pops up and requires a token or password, it likely means 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.
        
        ### References
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
