Metadata-Version: 2.1
Name: rhg-compute-tools
Version: 1.3.2
Summary: Tools for using compute.rhg.com and compute.impactlab.org
Home-page: https://github.com/RhodiumGroup/rhg_compute_tools
Author: Michael Delgado
Author-email: mdelgado@rhg.com
License: MIT license
Keywords: rhg_compute_tools
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/plain
Requires-Dist: google-cloud-storage
Requires-Dist: click
Requires-Dist: dask-gateway
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: bottleneck

=================
RHG Compute Tools
=================


.. image:: https://img.shields.io/pypi/v/rhg_compute_tools.svg
        :target: https://pypi.python.org/pypi/rhg_compute_tools
        :alt: PyPi package version

.. image:: https://github.com/RhodiumGroup/rhg_compute_tools/workflows/Python%20package/badge.svg
        :target: https://github.com/RhodiumGroup/rhg_compute_tools/actions
        :alt: Build status

.. image:: https://readthedocs.org/projects/rhg-compute-tools/badge/?version=latest
        :target: https://rhg-compute-tools.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

Tools for using compute.rhg.com and compute.impactlab.org


* Free software: MIT license
* Documentation: https://rhg-compute-tools.readthedocs.io.

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

pip:

.. code-block:: bash

    pip install rhg_compute_tools



Features
--------

Kubernetes tools
~~~~~~~~~~~~~~~~

* easily spin up a preconfigured cluster with ``get_cluster()``, or flavors with ``get_micro_cluster()``, ``get_standard_cluster()``, ``get_big_cluster()``, or ``get_giant_cluster()``.

.. code-block:: python

    >>> import rhg_compute_tools.kubernetes as rhgk
    >>> cluster, client = rhgk.get_cluster()

Google cloud storage utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Utilities for managing google cloud storage directories in parallel from the command line or via a python API

.. code-block:: python

   >>> import rhg_compute_tools.gcs as gcs
   >>> gcs.sync_gcs('my_data_dir', 'gs://my-bucket/my_data_dir')


