Metadata-Version: 2.1
Name: dea-tools
Version: 0.1.1
Summary: Functions and algorithms for analysing Digital Earth Australia data.
Home-page: https://github.com/GeoscienceAustralia/dea-notebooks
Author: Geoscience Australia
Author-email: dea@ga.gov.au
License: Apache License 2.0
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: ciso8601
Requires-Dist: pytz
Requires-Dist: requests
Requires-Dist: lxml
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: geopandas
Requires-Dist: datacube
Requires-Dist: tqdm
Requires-Dist: dask
Requires-Dist: rasterio
Requires-Dist: scikit-learn
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: GDAL
Requires-Dist: odc-ui
Requires-Dist: numexpr
Requires-Dist: folium
Requires-Dist: pyproj
Requires-Dist: branca
Requires-Dist: shapely
Requires-Dist: scikit-image
Requires-Dist: python-dateutil
Requires-Dist: OWSLib
Provides-Extra: boto
Requires-Dist: boto3 ; extra == 'boto'
Provides-Extra: jupyter
Requires-Dist: IPython ; extra == 'jupyter'
Requires-Dist: ipywidgets ; extra == 'jupyter'
Requires-Dist: ipyleaflet ; extra == 'jupyter'


dea-tools
=========

Python functions and algorithms developed to assist in analysing DEA data (e.g. loading data, plotting, spatial analysis, machine learning).

Installation
------------

To work with this module on the DEA Sandbox from within the `dea-notebooks` repo, you can add the Tools folder to the system path:

.. code-block:: python

   import sys
   sys.path.insert(1, '../Tools/')
   import dea_tools.datahandling  # or some other submodule

You can also `pip install` the module. To do this on the DEA Sandbox, run `pip` from the terminal:

.. code-block:: bash

   pip install -e Tools/

Install from the source on any other system with `pip`:

.. code-block:: bash

    pip install --extra-index-url="https://packages.dea.ga.gov.au" git+https://github.com/GeoscienceAustralia/dea-notebooks.git#subdirectory=Tools


Citing DEA Tools
----------------

If you use any of the notebooks, code or tools in this repository in your work, please reference them using the following citation:

    Krause, C., Dunn, B., Bishop-Taylor, R., Adams, C., Burton, C., Alger, M., Chua, S., Phillips, C., Newey, V., Kouzoubov, K., Leith, A., Ayers, D., Hicks, A., DEA Notebooks contributors 2021. Digital Earth Australia notebooks and tools repository. Geoscience Australia, Canberra. https://doi.org/10.26186/145234


Building and Releasing
----------------------

This section is only relevant to you if you are a developer of this package.

Building and releasing dea-tools requires that the package is built in-place. Either build with an editable pip installation or with `pip>=21.2` and `--use-feature=in-tree-build`. Building will generate a file, `dea_tools/__version__.py`, that is dynamic on release. It should not be committed. `setup.py` will detect if `__version__.py` exists and change its behaviour accordingly.

Build instructions:

.. code-block:: bash

        cd Tools
        rm dea_tools/__version__.py  # if necessary
        pip install . --use-feature=in-tree-build
        python -m build



