Provide an easy to use API for download oceanographic data.
Project description
SIAEXTRACTLIB
Version: 0.2.2
Python library as part of the SIA project. Its goal is to provide an easy to use interface that connects with oceanic data repositories to extract subsets of data programaticaly, taking care of the in-between steps, like network failures and size limitations from the source.
Page of the project: https://sia-information-system.github.io/sia-website
Table of content
Install
Production mode
You can install this package from PyPI using:
pip install siaextractlib
To install the package from source code, clone the repo from GitHub and
run the following command in the package root directory
(where the pyproject.toml
file is located):
pip install .
See local installation for details.
Development mode
NOTE: For development, it's recommended to use an isolated environment.
You can use tools like conda
(anaconda
/ minionda
) or virtualenv
to
create this kind of environments. We recommend conda
. If you don't want to use
conda
and you store the environment in the root directory of the project,
name it as venv
since this name of directory is ignored by git.
To install the package in development mode (--editable), run the following command
in the package root directory (where de pyproject.toml
file is located):
pip install --editable .[dev]
See local installation for details.
To increase the version number, the package bumpver
is used.
Read the docs
to see how to use it.
Tests
You need to first create and fill the etc/config.ini
file
before running the tests. See the template etc/config.ini.example
.
This file contains your credentials for
Copernicus.
Once done, at the test directory, run the following command to start the testing module:
python test_lib_opendap.py
Tests are written using the unittest
framework, so alternative ways of running
the tests are described in its documentation.
Documentation
Read the documentation for this package here.
Contributions
Rules are:
- First ask to maintainers if the new proposed feature can be added. You can open an issue on GitHub.
- Document every new feature added.
- Add tests for each new feature.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for siaextractlib-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 096a606915422e4ab525f0681a6b70391af96f77a82244f641d995f9fcb844c3 |
|
MD5 | 0d90b09cbb81de2573d3e0ce3ff3de23 |
|
BLAKE2b-256 | 16f724838cf4bc8fa822d143e77d468baba8d77471ad489c6e94bafd6c969e96 |