Metadata-Version: 2.1
Name: esgf-scraper
Version: 0.2.2
Summary: Keeps a local data repository in syncronisation with ESGF
Home-page: https://gitlab.com/magicc/esgf-scraper
Author: Jared Lewis
Author-email: jared.lewis@climate-energy-college.org
License: MIT License
Project-URL: Documentation, https://magicc.gitlab.io/esgf-scraper/
Project-URL: Source, https://gitlab.com/magicc/esgf-scraper
Keywords: esgf,cmip6,scrape
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: click
Requires-Dist: scrapy
Requires-Dist: esgf-pyclient
Requires-Dist: myproxyclient
Requires-Dist: pyyaml
Requires-Dist: pandas
Provides-Extra: deploy
Requires-Dist: twine (>=1.11.0) ; extra == 'deploy'
Requires-Dist: setuptools (>=38.6.0) ; extra == 'deploy'
Requires-Dist: wheel (>=0.31.0) ; extra == 'deploy'
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: codecov ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest (>=4.0) ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: sphinx (>=1.4) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-click ; extra == 'dev'
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
Requires-Dist: setuptools (>=38.6.0) ; extra == 'dev'
Requires-Dist: wheel (>=0.31.0) ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.4) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-click ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: codecov ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest (>=4.0) ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'

ESGF Scraper
============

.. sec-begin-index

+-------------------+----------------+-----------+
| Repository health | |Build Status| | |Codecov| |
+-------------------+----------------+-----------+

ESGF Scraper is a tool for downloading and processing climate data from the Earth System Grid Federation (ESGF_). ESGF is an international
collaborative network specifically designed for dissemination of climate model output for large scale projects such as CMIP6.

.. _ESGF: https://esgf.llnl.gov/

.. |Build Status| image:: https://gitlab.com/magicc/esgf-scraper/badges/master/pipeline.svg
    :target: https://gitlab.com/magicc/esgf-scraper/commits/master
.. |Codecov| image:: https://gitlab.com/magicc/esgf-scraper/badges/master/coverage.svg?job=test
    :target: https://gitlab.com/magicc/esgf-scraper/commits/master

.. sec-end-index

Documentation
-------------
See the `documentation <https://magicc.gitlab.io/esgf-scraper/>`_ for examples of using ``esgf-scraper``

.. sec-begin-installation

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

esgf-scraper is not currently `pip <https://pypi.org/project/pip/>`_ installable as the code is not publically accessible. To install, you must checkout the
code from `GitLab <https://gitlab.com/magicc/esgf-scraper>`_.

::

  git clone git@gitlab.com:magicc/esgf-scraper.git
  cd esgf-scraper
  make virtual-environment
  cp esgf_scraper.conf.sample ~/esgf_scraper.conf

After this has been completed, the configuration file will need to be updated with new configuration. See TODO for more information
about the contents of the configuration file.

.. sec-end-installation

Contributing
------------

If you'd like to contribute, please make a pull request!
The pull request templates should ensure that you provide all the necessary information.

.. sec-begin-license

License
-------

This package is licensed under a `MIT license <https://opensource.org/licenses/MIT>`_, unless noted otherwise for specific parts.

.. sec-end-license

