معرفی شرکت ها
copernicus-marine-client-0.5.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
-
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | copernicus-marine-client-0.5.1 |
| نام | copernicus-marine-client |
| نسخه کتابخانه | 0.5.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | jsouchard |
| ایمیل نویسنده | jsouchard@mercator-ocean.fr |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/copernicus-marine-client/ |
| مجوز | - |
# Copernicus Marine Service client
A library to facilitate the access of Copernicus Marine Service products and datasets.
## Introduction
This package allows to recover products and datasets information from Command Line Interface or with Python code,
as well as download subsets and native files.
## Command Line Interface (CLI)
### Command *describe*
Retrieve information about products as JSON:
```
> copernicus-marine describe
{
"products": [
{
"title": "Antarctic Sea Ice Extent from Reanalysis",
"product_id": "ANTARCTIC_OMI_SI_extent",
"thumbnail_url": "https://catalogue.marine.copernicus.eu/documents/IMG/ANTARCTIC_OMI_SI_extent.png",
"production_center": "Mercator Oc\u00e9an International",
"creation_datetime": "2018-02-12",
"modified_datetime": "2018-02-12",
}
...
]
}
```
Retrieve all information about datasets as JSON:
```
> copernicus-marine describe --include-datasets
{
"products": [
{
"title": "Antarctic Sea Ice Extent from Reanalysis",
"product_id": "ANTARCTIC_OMI_SI_extent",
"thumbnail_url": "https://catalogue.marine.copernicus.eu/documents/IMG/ANTARCTIC_OMI_SI_extent.png",
"production_center": "Mercator Oc\u00e9an International",
"creation_datetime": "2018-02-12",
"modified_datetime": "2018-02-12",
"datasets": [
{
"dataset_id": "antarctic_omi_si_extent",
"dataset_name": "antarctic_omi_si_extent",
"services": [
{
"protocol": "ftp",
"uri": "ftp://my.cmems-du.eu/Core/ANTARCTIC_OMI_SI_extent/antarctic_omi_si_extent"
}
],
"variables": []
}
]
},
...
]
}
```
Check out the help:
```
> copernicus-marine describe --help
Usage: copernicus-marine describe [OPTIONS]
Options:
--one-line Output JSON on one line
--include-description Include product description in output
--include-datasets Include product dataset details in output
--include-keywords Include product keyword details in output
-c, --contains TEXT Filter catalogue output. Returns products with
attributes matching a string token
--overwrite-cache Force to refresh the catalogue by overwriting the
local cache
--help Show this message and exit.
```
### Command *subset*
Download a dataset subset, based on dataset id, variable names and attributes slices:
```
> copernicus-marine subset -i METOFFICE-GLO-SST-L4-NRT-OBS-SST-V2 -v analysed_sst -v sea_ice_fraction -t 2021-01-01 - T 2021-01-03 -x 0.0 -X 0.1 -y 0.0 -Y 0.1
< Login:
< Password:
< Trying to download as one file...
```
File downloaded to ./{dataset_id}.nc if not specified otherwise (through -o/--output-directory and -f/--output-filename options).
Check out the help:
```
> copernicus-marine subset --help
Usage: copernicus-marine subset [OPTIONS]
Downloads subsets of datasets as NetCDF files. Either one of 'dataset-
id' or 'dataset-url' is required (can be found via the 'copernicus-
marine describe' command).
Example:
copernicus-marine subset --dataset-id METOFFICE-GLO-SST-L4-NRT-OBS-SST-V2
--variable analysed_sst --variable sea_ice_fraction --start-datetime
2021-01-01 --end-datetime 2021-01-02 --minimal-longitude 0.0 --maximal-
longitude 0.1 --minimal-latitude 0.0 --maximal-latitude 0.1
copernicus-marine subset -i METOFFICE-GLO-SST-L4-NRT-OBS-SST-V2 -v
analysed_sst -v sea_ice_fraction -t 2021-01-01 -T 2021-01-02 -x 0.0 -X
0.1 -y 0.0 -Y 0.1
Options:
-u, --dataset-url TEXT The full dataset URL
-i, --dataset-id TEXT The dataset id
--login TEXT
--password TEXT
-v, --variable TEXT Specify dataset variables
-x, --minimal-longitude FLOAT RANGE
Minimal longitude for the subset
[-180<=x<=180]
-X, --maximal-longitude FLOAT RANGE
Maximal longitude for the subset
[-180<=x<=180]
-y, --minimal-latitude FLOAT RANGE
Minimal latitude for the subset
[-90<=x<=90]
-Y, --maximal-latitude FLOAT RANGE
Maximal latitude for the subset
[-90<=x<=90]
-z, --minimal-depth FLOAT RANGE
Minimal depth for the subset [x>=0]
-Z, --maximal-depth FLOAT RANGE
Maximal depth for the subset [x>=0]
-t, --start-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
The start datetime of the temporal subset
-T, --end-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
The end datetime of the temporal subset
-o, --output-directory PATH The destination folder for the downloaded
files. Default is the current directory
[required]
-f, --output-filename PATH Concatenate the downloaded data in the given
file name (under the output path)
--assume-yes Flag to skip confirmation before download
--force-protocol [opendap|motu]
Force download through one of the available
protocols
--dry-run Flag to specify NOT to send the request to
external server. Returns the request instead
--request-file PATH Option to pass a filename corresponding to a
file containg CLI arguments. The file MUST
follow the structure of dataclass
'SubsetRequest'. ANY PARAMETER SPECIFIED
ASIDE FROM FILE WILL NOT BE TAKEN INTO
CONSIDERATION FOR THE REQUEST IF FILE IS
SPECIFIED.
--help Show this message and exit.
```
### Command *native*
Download a native file (or files), based on dataset id or path to files:
Example:
```
> copernicus-marine native -u ftp://my.cmems-du.eu/Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/
< Login:
< Password:
< You requested the download of the following files:
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202207.nc - 3.27 MB
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202208.nc - 3.29 MB
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202209.nc - 3.28 MB
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202210.nc - 3.26 MB
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202211.nc - 3.26 MB
Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m/2022/metoffice_foam1_amm7_NWS_DIATO_CPWC_mm202212.nc - 3.26 MB
Total size of the download: 19.62 MB
Do you want to continue? [y/N]:
```
File(s) downloaded to ./{path}/{filename} if not specified otherwise:
- "--output-path" specifies a directory to dump the files in
- "--no-directories" to not recreate the folder structure
If not specified otherwise, after the header display with a summary of the request,
the user is asked for confirmation:
- "--no-confirmation" to turn down the confirmation prompt
- "--show-outputnames" to display the full paths of the outputs files
Check out the help:
```
> copernicus-marine native --help
Usage: copernicus-marine native [OPTIONS]
Downloads native data files based on dataset_id or datafiles url path.
The function fetches the files recursively if a folder path is passed as
url. When provided a dataset id, all the files in the corresponding
folder will be downloaded.
By default for any download request, a summary of the request result is
displayed to the user and a confirmation is asked. This can be
turned down. Example:
copernicus-marine native -nd -o data_folder --dataset-id
cmems_mod_nws_bgc-pft_myint_7km-3D-diato_P1M-m
copernicus-marine native -nd -o data_folder --dataset-url
ftp://my.cmems-du.eu/Core/NWSHELF_MULTIYEAR_BGC_004_011/cmems_mod_nws_bgc-
pft_myint_7km-3D-diato_P1M-m
Options:
-u, --dataset-url TEXT Path to the data files
-i, --dataset-id TEXT The dataset id
--login TEXT
--password TEXT
-nd, --no-directories Option to not recreate folder hierarchy in
ouput directory.
--show-outputnames Option to display the names of the output files
before download.
-o, --output-directory PATH The destination directory for the downloaded
files. Default is the current directory
[required]
--assume-yes Whether to ask for confirmation before
download, after header display. If 'True',
skips confirmation.
--dry-run Flag to specify NOT to send the request to
external server. Returns the request instead
--request-file PATH Option to pass a file containg CLI arguments.
The file MUST follow the structure of dataclass
'SubsetRequest'. ANY PARAMETER SPECIFIED ASIDE
FROM FILE WILL NOT BE TAKEN INTO CONSIDERATION
FOR THE REQUEST IF FILE IS SPECIFIED.
--help Show this message and exit.
```
## Installation
Using pip, for example:
```
pip install copernicus-marine-client
```
## Technical details
This module is organized around two capabilities:
- a catalogue, parsed from web requests, that contains informations on the available datasets
- a downloader, to simplify the download of dataset files or subsets
The catalogue can be displayed by the user and is used by the downloader to link the user
requests with files or subset of files to retrieve.
The downloader will help the user download the needed datasets.
A rigid format, specified in "request_structure.py" is used to ensure conformity of the information passed between the CLI command and the python functions.
For subset command, the format is:
```
@dataclass
class SubsetRequest:
dataset_url: Optional[str] = None
dataset_id: Optional[str] = None
variables: Optional[List[str]] = None
minimal_longitude: Optional[float] = None
maximal_longitude: Optional[float] = None
minimal_latitude: Optional[float] = None
maximal_latitude: Optional[float] = None
minimal_depth: Optional[float] = None
maximal_depth: Optional[float] = None
start_datetime: Optional[datetime] = None
end_datetime: Optional[datetime] = None
output_directory: Optional[str] = None
output_filename: Optional[str] = None
assume_yes: Optional[bool] = None
force_protocol: Optional[str] = None
dry_run: Optional[bool] = None
```
نیازمندی
| مقدار | نام |
|---|---|
| >=0.27.2 | owslib |
| >=8.0.4 | click |
| >=1.0 | numpy |
| >=2.27.1 | requests |
| >0.8.0 | opendap-downloader |
| >=62.0.0 | setuptools |
| ==1.8.4 | motuclient |
| >=2.0.2 | cachier |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9 | Python |
نحوه نصب
نصب پکیج whl copernicus-marine-client-0.5.1:
pip install copernicus-marine-client-0.5.1.whl
نصب پکیج tar.gz copernicus-marine-client-0.5.1:
pip install copernicus-marine-client-0.5.1.tar.gz