Metadata-Version: 2.1
Name: tima-mindif
Version: 1.4.0
Summary: TIMA Min Dif Processor
Home-page: https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor
Maintainer: Samuel Bradley
Maintainer-email: sam.bradley@csiro.au
License: MIT
Description: # TIMA Mindif Processor v1.4.0
        
        [![PyPI version](https://badge.fury.io/py/tima-mindif.svg)](https://badge.fury.io/py/tima-mindif)
        [![pipeline status](https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor/badges/master/pipeline.svg)](https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor/commits/master)
        [![coverage report](https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor/badges/master/coverage.svg)](https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor/commits/master)
        
        ## Getting Started
        
        install from pypi
        
        ```
        pip install tima-mindef
        ```
        
        Install direct from git (Note: this is currently a private repository)
        
        ```
        pip install git+https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor.git
        ```
        
        Or clone the repo so you can make changes or view the code, note the -e in the pip install is optional, it makes it so any code changes are automatically picked up.
        
        ```
        git clone https://gitlab.com/csiro-geoanalytics/tima-utils/tima-mindif-processor.git
        <Navigate to the code directory>
        pip install -e .
        ```
        
        If you would like to work on the code in a virtual env a pipfile is available
        
        ```
        pip install pipenv
        pipenv install
        pipenv shell
        ```
        
        ## Usage
        
        Once it's installed use the command 'tima-mindef'
        
        ```
        tima-mindef -h
        
        usage: tima-mindif [-h] [--output OUTPUT] [--verbose] [--exclude-unclassified]
                           [--show-low-val] [--thumbs]
                           project_path mindif_root
        
        Process TIMA data
        
        positional arguments:
          project_path          Path to the TIMA project
          mindif_root           Path to the MinDif root
        
        optional arguments:
          -h, --help            show this help message and exit
          --output OUTPUT, -o OUTPUT
                                Path to the desired output folder
          --verbose             Prints more information about app progress.
          --exclude-unclassified, -u
                                Exclude unclassified rock types from image
          --show-low-val, -l    Prints rock types with <0.01 in the legend.
          --thumbs              Create thumbnails.
        
        ```
        
        The script should be executed in the following manner:
        tima-mindef tima_mindif_processor.py project/path mindif_root output_root
        
        For example:
        
        ```
        tima-mindef "/media/sf_Y_DRIVE/Data/Evolution" "/media/sf_Y_DRIVE/Data/Adam Brown" -o ./output
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
