Skip to main content

MARIS companion package and tutorials

Project description

marisco

The IAEA Marine Radioactivity Information System (MARIS) allows free access to users to search and download the results of measurements of radioactivity in seawater, biota, sediment and suspended matter. MARIS is maintained and developed by the IAEA Environmental Laboratories in Monaco.

The present Python package provides command-line utilities to:

  1. Encode harvested datasets as NetCDF or .csv formats
  2. Interact with the IAEA Open Data platform soon available
  3. Provide data preprocessing pipelines for ad-hoc datasets

Prerequisites

We recommend to use the “Mamba” python package manager to create a clean and “deterministic” python environment.

Once installed, a typical Mamba workflow could be:

# Create an isolated env. with your prefered python version
mamba create -n name-of-your-env python=3.9 

# Then
mamba activate name-of-your-env
mamba install your-packages-of-interest
mamba deactivate # To quit your environment

Install & configuration

Now, to install marisco simply run

pip install marisco

Once successfully installed, run the following command:

maris_init

This script will create a .marisco/ directory containing various configuration/configurable files in your /home directory including:

  • cdl.toml: MARIS NetCDF4 CDL (Common Data Language.
  • configs.toml: contains several configurable constants, default paths, …
  • lut/: directory containing several MARIS DB nomenclature files
  • maris-template.nc: MARIS NetCDF4 template generated from the cdl and use to encode MARIS datasets

Notes: conda/mamba installer will be also available soon.

How to use

Command line utilities

All commands accept a -h argument to get access to its documentation.

maris_init

Create configuration files, MARIS NetCDF CDL (Common Data Language) and donwload required lookup tables (nomenclatures).

maris_create_nc_template

Generate MARIS NetCDF template to be used when encoding datasets

maris_netcdfy

Encode MARIS dataset as NetCDF using Jupyter Notebook handlers

Positional arguments:

  • data: Path to dataset to encode
  • nb_in: Path to Jupyter noteboook (NetCDF handler) to execute
  • nc_out: Path to generated NetCDF4

Example:

maris_netcdfy _data/xls/tepco/coastal_water.xlsx nbs/handlers/tepco.ipynb _data/output/tepco.nc

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marisco-0.1.2.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

marisco-0.1.2-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file marisco-0.1.2.tar.gz.

File metadata

  • Download URL: marisco-0.1.2.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for marisco-0.1.2.tar.gz
Algorithm Hash digest
SHA256 db1a8fb08f8b311d68816650a64cf708fe3bb3e6c7574373b383a4549f4746e3
MD5 87af9c52b950fd39f71d40e5c9b6297f
BLAKE2b-256 0cb93b6604d4be252141943692e46a5c6fdc1378b99910c8b00480475dce6866

See more details on using hashes here.

File details

Details for the file marisco-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: marisco-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for marisco-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cc97c3b863bda38db1ccccb186cdcbdc09ad3024548098aba5f950019a7afffc
MD5 0f18eb4237be5cc28eee9dff4f8a3e7a
BLAKE2b-256 8166d098b80f2abcceb3e6b78af3709704f4e8ba55a9c03fa1bd4b00aba2b4f5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page