Metadata-Version: 2.1
Name: uncover-ml
Version: 0.3.0
Summary: Machine learning tools for the Geoscience Australia uncover project
Home-page: https://github.com/GeoscienceAustralia/uncover-ml
Author: Geoscience Australia Mineral Systems Group, NICTA Spatial Inference Systems Team
Author-email: John.Wilford@ga.gov.au
License: Apache Software License 2.0
Keywords: uncover-ml
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Dist: Cython (==0.29.13)
Requires-Dist: PyKrige (==1.3.0)
Requires-Dist: PyYAML (==5.1.2)
Requires-Dist: affine (==2.3.0)
Requires-Dist: click (==7.0)
Requires-Dist: eli5 (==0.10.1)
Requires-Dist: matplotlib (==3.1.1)
Requires-Dist: mpi4py (==3.0.2)
Requires-Dist: numpy (==1.17.2)
Requires-Dist: pandas (==0.25.1)
Requires-Dist: ppretty (==1.3)
Requires-Dist: pyproj (==2.4.1)
Requires-Dist: pyshp (==1.2.3)
Requires-Dist: rasterio (==1.1.0)
Requires-Dist: revrand (==1.0.0)
Requires-Dist: scikit-image (==0.15.0)
Requires-Dist: scikit-learn (==0.21.3)
Requires-Dist: scipy (==1.3.1)
Requires-Dist: seaborn (==0.9.0)
Requires-Dist: xgboost (==0.90)
Provides-Extra: dev
Requires-Dist: IPython (==7.8.0) ; extra == 'dev'
Requires-Dist: codecov (==2.0.15) ; extra == 'dev'
Requires-Dist: ghp-import (==0.5.5) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.8.1) ; extra == 'dev'
Requires-Dist: pytest (==5.2.1) ; extra == 'dev'
Requires-Dist: setuptools (>=41.4.0) ; extra == 'dev'
Requires-Dist: sphinx (==2.2.0) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (>=1.8.0) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (==0.4.3) ; extra == 'dev'
Requires-Dist: sphinxcontrib-programoutput (==0.15) ; extra == 'dev'
Requires-Dist: twine (==2.0.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.33.6) ; extra == 'dev'
Provides-Extra: kmz
Requires-Dist: pillow ; extra == 'kmz'
Requires-Dist: simplekml ; extra == 'kmz'

uncover ML
==========

.. image:: https://circleci.com/gh/GeoscienceAustralia/uncover-ml/tree/develop.svg?style=svg
    :target: https://circleci.com/gh/GeoscienceAustralia/uncover-ml/tree/develop  

.. image:: https://codecov.io/gh/GeoscienceAustralia/uncover-ml/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/GeoscienceAustralia/uncover-ml

Machine learning tools for the Geoscience Australia uncover project.

Quickstart
----------

Before you start, make sure your system has the following packages installed,

- gdal (libgdal-dev)
- openmpi
- hdf5

And your Python environment has:

- numpy
- scipy
- matplotlib
- Cython

We strongly recommend using a virtual environment.
To install, simply run ``setup.py``:

.. code:: console

   $ python setup.py install

or install with ``pip``:

.. code:: console

   $ pip install git+https://github.com/GeoscienceAustralia/uncover-ml.git@release

The Python requirements should automatically be built and installed.

Installation and Usage
----------------------

UncoverML can be run on a local Linux machine or a HPC platform such as NCI's Raijin. For
detailed installation and usage instructions, see the `documentation <http://GeoscienceAustralia.github.io/uncover-ml>`_.

Useful Links
------------

Home Page
    http://github.com/GeoscienceAustralia/uncover-ml

Documentation
    http://GeoscienceAustralia.github.io/uncover-ml

Issue tracking
    https://github.com/GeoscienceAustralia/uncover-ml/issues


Bugs & Feedback
---------------

For bugs, questions and discussions, please use 
`Github Issues <https://github.com/GeoscienceAustralia/uncover/issues>`_.


