Metadata-Version: 2.1
Name: stac2dcache
Version: 0.3.0
Summary: Python tool to create and manipulate STAC catalogs on a dCache storage system
Home-page: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache
Author: Team Atlas
Author-email: team-atlas@esciencecenter.nl
License: Apache Software License 2.0
Keywords: stac2dcache
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Requires-Dist: aiohttp
Requires-Dist: dcachefs (>=0.1.4)
Requires-Dist: fsspec
Requires-Dist: geopandas
Requires-Dist: pystac (>=1.2)
Requires-Dist: urlpath
Requires-Dist: rasterio
Requires-Dist: rioxarray
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pycodestyle ; extra == 'test'

.. list-table::
   :widths: 25 25
   :header-rows: 1

   * - fair-software.nl recommendations
     - Badges
   * - \1. Code repository
     - |GitHub Badge|
   * - \2. License
     - |License Badge|
   * - \3. Community Registry
     - |PyPI Badge|
   * - \4. Enable Citation
     - 
   * - \5. Checklist
     - 
   * - **Other best practices**
     -
   * - Continuous integration
     - |Python Build| |PyPI Publish|

.. |GitHub Badge| image:: https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue
   :target: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache
   :alt: GitHub Badge

.. |License Badge| image:: https://img.shields.io/github/license/NLeSC-GO-common-infrastructure/stac2dcache
   :target: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache
   :alt: License Badge

.. |PyPI Badge| image:: https://img.shields.io/pypi/v/stac2dcache.svg?colorB=blue
   :target: https://pypi.python.org/project/stac2dcache/
   :alt: PyPI Badge

.. |Python Build| image:: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache/workflows/Build/badge.svg
   :target: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache/actions?query=workflow%3A%22Build%22
   :alt: Python Build

.. |PyPI Publish| image:: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache/workflows/Publish/badge.svg
   :target: https://github.com/NLeSC-GO-common-infrastructure/stac2dcache/actions?query=workflow%3A%22Publish%22
   :alt: PyPI Publish

################################################################################
STAC2dCache
################################################################################

STAC2dCache is a Python tool to create and manipulate STAC catalogs on a 
dCache storage system such as the 
`infrastructure available at SURF <http://doc.grid.surfsara.nl/en/latest/Pages/Advanced/grid_storage.html>`_. 
It is based on `PySTAC <https://github.com/stac-utils/pystac>`_ and it offers the 
following additional functionalities:

* download remote assets to the local filesystem or to a dCache storage;
* load assets using a set of predefined drivers (e.g. for raster data, and
  text files)
* open a catalog as a `geopandas <https://github.com/geopandas/geopandas>`_ 
  data-frame.

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

To install STAC2dCache, do:

.. code-block:: console

  pip install stac2dcache

or:

.. code-block:: console

  git clone https://github.com/NLeSC-GO-common-infrastructure/stac2dcache.git
  cd stac2dcache
  pip install .


Run tests (including coverage) with:

.. code-block:: console

  python setup.py test


Documentation
*************

A short `tutorial <notebooks/tutorial.ipynb>`_ illustrates how 
to use STAC2dCache.

Contributing
************

If you want to contribute to the development of STAC2dCache,
have a look at the `contribution guidelines <CONTRIBUTING.rst>`_.

License
*******

Copyright (c) 2020, Netherlands eScience Center

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.



Credits
*******

This package was created with `Cookiecutter <https://github.com/audreyr/cookiecutter>`_ and the `NLeSC/python-template <https://github.com/NLeSC/python-template>`_.




