Skip to content

Commit

Permalink
remove WIS1/WCMP1 support
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Sep 15, 2023
1 parent 5a2c034 commit 94d3873
Show file tree
Hide file tree
Showing 18 changed files with 4 additions and 6,073 deletions.
51 changes: 3 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

## Pythonic API to WMO WIS Catalogue

pywiscat provides a Pythonic API atop the WMO WIS Catalogue in support
of reporting and analysis of the WIS Catalogue and Metadata.
pywiscat provides a Pythonic API atop the WMO WIS2 Catalogue in support
of reporting and analysis of the WIS2 Catalogue and its associated discovery metadata.

## Installation

Expand Down Expand Up @@ -34,7 +34,7 @@ python3 setup.py install

## Running

The canonical URL for the GDC is 'https://api.weather.gc.ca/collections/wis2-discovery-metadata.
The canonical URL for the GDC is https://api.weather.gc.ca/collections/wis2-discovery-metadata.

To use a different catalogue, set the `PYWISCAT_GDC_URL` environmnent variable before running pywiscat.

Expand All @@ -44,40 +44,6 @@ From command line:
# fetch version
pywiscat --version

## WIS 1.0 workflows

# catalogue management

# download bundle of WIS metadata to disk
pywiscat wis1 catalogue cache --directory /path/to/metadata/files

# search for terms (case-insensitive) and group by organization

# search for 'nwp'
pywiscat wis1 report terms-by-org --directory=/path/to/metadata/files --term nwp

# search for 'nwp' and 'model' (exclusive)
pywiscat wis1 report terms-by-org --directory=/path/to/metadata/files --term nwp --term model

# search for 'nwp' in verbose mode (Python logging levels)
pywiscat wis1 report terms-by-org --directory=/path/to/metadata/files --term nwp --verbosity DEBUG

# KPI assesment

# run KPI assesment (aka pywcmp) on all metadata files in a directory with default ("brief") output
pywiscat wis1 report kpi --directory /path/to/metadata/files

# run KPI assesment on selected metadata files printing out the "summary" section for each file
pywiscat wis1 report kpi --file-list /path/to/metadata/file_list.json --output-format summary

# run assesment of KPI 1 (ATS) on all metadata files in a directory with "full" output
pywiscat wis1 report kpi -k1 --directory /path/to/metadata/files --output-format full

# other reports

# list number of records per organization
pywiscat wis1 report records-by-org --directory=/path/to/metadata/files

## WIS2 workflows

# search the WIS2 Global Discovery Catalogue (GDC)
Expand All @@ -96,17 +62,6 @@ pywiscat wis2 get urn:x-wmo:md:can:eccc-msc:c7c9d726-c48a-49e3-98ab-78a1ab87cda8
## Using the API
```python

## WIS 1.0 workflows

from pywiscat.wis1.catalogue import cache_catalogue
from pywiscat.wis1.report import group_search_results_by_organization

# catalogue management
status = cache_catalogue('/path/to/directory')

# search for terms (case-insensitive) and group by organization
results_dict = group_search_results_by_organization('path/to/directory', terms=['nwp', 'model'])

## WIS2 workflows

from pywiscat.wis2.catalogue import search, get
Expand Down
2 changes: 0 additions & 2 deletions pywiscat/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

import click

from pywiscat.wis1 import wis1
from pywiscat.wis2 import wis2

__version__ = '0.1.dev0'
Expand All @@ -41,5 +40,4 @@ def cli():
pass


cli.add_command(wis1)
cli.add_command(wis2)
43 changes: 0 additions & 43 deletions pywiscat/wis1/__init__.py

This file was deleted.

106 changes: 0 additions & 106 deletions pywiscat/wis1/catalogue.py

This file was deleted.

Loading

0 comments on commit 94d3873

Please sign in to comment.