Skip to content

Commit

Permalink
Deploy v1.8.1 from 5415ec6
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 20, 2024
1 parent 2486dd6 commit 7b1bba0
Show file tree
Hide file tree
Showing 234 changed files with 43,777 additions and 1 deletion.
2 changes: 1 addition & 1 deletion latest
4 changes: 4 additions & 0 deletions v1.8.1/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8f23f83272046b59dd86c0692981ccde
tags: 645f666f9bcd5a90fca523b33c5a78b7
447 changes: 447 additions & 0 deletions v1.8.1/_modules/index.html

Large diffs are not rendered by default.

513 changes: 513 additions & 0 deletions v1.8.1/_modules/pooch.html

Large diffs are not rendered by default.

1,287 changes: 1,287 additions & 0 deletions v1.8.1/_modules/pooch/core.html

Large diffs are not rendered by default.

1,622 changes: 1,622 additions & 0 deletions v1.8.1/_modules/pooch/downloaders.html

Large diffs are not rendered by default.

669 changes: 669 additions & 0 deletions v1.8.1/_modules/pooch/hashes.html

Large diffs are not rendered by default.

863 changes: 863 additions & 0 deletions v1.8.1/_modules/pooch/processors.html

Large diffs are not rendered by default.

800 changes: 800 additions & 0 deletions v1.8.1/_modules/pooch/utils.html

Large diffs are not rendered by default.

57 changes: 57 additions & 0 deletions v1.8.1/_sources/about.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _about:

Why use Pooch?
==============

Use cases
---------

.. tab-set::

.. tab-item:: Just download a file

**Who**: Scientists/researchers/developers looking to simply download a
file.

Pooch makes it easy to download a file (one function call).
On top of that, it also comes with some bonus features:

* Download and cache your data files locally (so it's only downloaded
once).
* Make sure everyone running the code has the same version of the data
files by verifying cryptographic hashes.
* Multiple download protocols HTTP/FTP/SFTP and basic authentication.
* Download from Digital Object Identifiers (DOIs) issued by repositories
like figshare and Zenodo.
* Built-in utilities to unzip/decompress files upon download

**Start here:** :ref:`retrieve`

.. tab-item:: Manage sample data for a Python program

**Who**: Package developers wanting to include sample data for use in
tutorials and tests.

Pooch was designed for this! It offers:

* Pure Python and :ref:`minimal dependencies <dependencies>`.
* Download a file only if necessary.
* Verification of download integrity through cryptographic hashes.
* Extensible design: plug in custom download and post-processing functions.
* Built-in utilities to unzip/decompress files upon download
* Multiple download protocols HTTP/FTP/SFTP and basic authentication.
* User control of data cache location through environment variables.

**Start here:** :ref:`intermediate`

History
-------

Pooch was born out of shared need between the
`Fatiando a Terra <https://www.fatiando.org>`__ libraries and
`MetPy <https://unidata.github.io/MetPy/>`__.
During the
`Scipy Conference 2018 <https://www.youtube.com/playlist?list=PLYx7XA2nY5Gd-tNhm79CNMe_qvi35PgUR>`__
sprints, developers from both projects got together and, realizing the shared
necessity, devised a package that would combine the best of the existing
functionality already present in each project and extend it's capabilities.
142 changes: 142 additions & 0 deletions v1.8.1/_sources/api/generated/pooch.DOIDownloader.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
pooch.DOIDownloader
===================

.. currentmodule:: pooch

.. autoclass:: DOIDownloader

.. rubric:: Methods Summary

.. autosummary::


DOIDownloader.__call__




























































----



.. automethod:: DOIDownloader.__call__





























































.. raw:: html

<div style='clear:both'></div>
154 changes: 154 additions & 0 deletions v1.8.1/_sources/api/generated/pooch.Decompress.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
pooch.Decompress
================

.. currentmodule:: pooch

.. autoclass:: Decompress

.. rubric:: Methods Summary

.. autosummary::


Decompress.__call__


































































----



.. automethod:: Decompress.__call__



































































.. raw:: html

<div style='clear:both'></div>
Loading

0 comments on commit 7b1bba0

Please sign in to comment.