MSC GeoMet pygeoapi server configuration and utilities
- Python 3
- virtualenv
Dependencies are listed in requirements.txt. Dependencies are automatically installed during msc-pygeoapi installation.
Dependencies of note:
- Elasticsearch (5 or above)
- i.e.
sudo echo
deb https://artifacts.elastic.co/packages/5.x/apt stable main> /etc/apt/sources.list.d/elastic.list
- pygeoapi
# setup virtualenv
python3 -m venv --system-site-packages msc-pygeoapi
cd msc-pygeoapi
source bin/activate
# clone codebase and install
git clone https://github.com/ECCC-MSC/msc-pygeoapi.git
cd msc-pygeoapi
python setup.py build
python setup.py install
# configure environment
cp msc-pygeoapi.env dev.env
vi dev.env # edit paths accordingly
. dev.env
# serve API
pygeoapi serve
msc-pygeoapi --version
Server will be located at http://localhost/features
# all collections
http://localhost/features/collections
# hydrometric daily mean
http://localhost/features/collections/hydrometric-daily-mean
# filter by time
http://localhost/features/collections/hydrometric-daily-mean/items?time=2011-11-11/2012-11-11
# filter by bbox
http://localhost/features/collections/hydrometric-daily-mean/items?bbox=-80,45,-50,55
# filter by station number
http://localhost/features/collections/hydrometric-daily-mean/items?STATION_NUMBER=02RH066
# filter by bbox
http://localhost/features/collections/hydrometric-daily-mean/items?bbox=-80,40,-50,54
# filter by station number and time
http://localhost/features/collections/hydrometric-daily-mean/items?STATION_NUMBER=02RH066&time=2011-01-01/2012-12-31
# filter by station number and time, limit results
http://localhost/features/collections/hydrometric-daily-mean/items?STATION_NUMBER=02RH066&time=2011-01-01/2012-12-31&limit=100
# filter by station number and time, limit and page results
http://localhost/features/collections/hydrometric-daily-mean/items?STATION_NUMBER=02RH066&time=2011-01-01/2012-12-31&limit=100&startindex=100
# HTML respsonses
# filter by active stations in Nunavut
http://localhost/features/collections/hydrometric-stations/items?STATUS_EN=Active&limit=5000&f=html&PROV_TERR_STATE_LOC=NU
pip install -r requirements-oracle.txt
# view all data loaders available
msc-pygeoapi data
# examples for some loaders
msc-pygeoapi data hydat <rest of flags/parameters>
msc-pygeoapi data climate-archive <rest of flags/parameters>
msc-pygeoapi data ahccd_cmip5 <rest of flags/parameters>
msc-pygeoapi data marine-weather add -d <path_to_directory of XML files>
# bulletins - delete index
msc-pygeoapi data bulletins_realtime delete-index # use --yes flag to bypass prompt
# realtime - standard workflow
msc-pygeoapi data hydrometric-realtime cache-stations # download stations list to $MSC_PYGEOAPI_CACHEDIR location
sr_subscribe start deploy/default/sarracenia/hydrometric_realtime.conf # begin realtime update process
msc-pygeoapi data hydrometric-realtime clean-indexes --days 30 # use --yes flag to bypass prompt (usually in crontab)
# run the CCCS Raster drill process (returns GeoJSON by default)
msc-pygeoapi process cccs execute raster-drill --y=45 --x=-75 --layer=CMIP5.SFCWIND.HISTO.WINTER.ABS_PCTL95
# run the CCCS Raster drill process returning CSV
msc-pygeoapi process cccs execute raster-drill --y=45 --x=-75 --layer=CMIP5.SFCWIND.HISTO.WINTER.ABS_PCTL95 --format=CSV
# install dev requirements
pip install -r requirements-dev.txt
# API tests run against http://localhost:5000
# use --url to override
# run all tests
pytest
# run one test file
pytest test/test_hydat.py
# override endpoint
pytest test/test_hydat.py --url https://example.org/dev
# skip API tests (run only unit tests)
pytest -k 'not api'
python setup.py sdist bdist_wheel --universal
twine upload dist/*
All bugs, enhancements and issues are managed on GitHub.