Skip to main content

Tools for OptimESM

Project description

OptimESM Tools

DOI Coverage Status PyPI version shields.io Python Versions PyPI downloads CodeFactor

J.R. Angevaare (KNMI)

Software

This software is used in the scope of the OptimESM project. The scientific aim is to isolate regions of three dimensional earth science data (time, latitude and longitude) from CMIP6 and identify regions in latitude-longitude that show dramatic changes as function of time.

Setup and installation

This software requires cdo and cartopy, and preferably also latex.

To install cdo and py-cdo, we use miniforge, but alternative methods exits. To use miniforge (on linux):

wget https://github.com/conda-forge/miniforge/releases/download/25.3.0-3/Miniforge3-Linux-x86_64.sh
bash Miniforge3-Linux-x86_64.sh

Create an environment, e.g.:

conda create -n py310 python=3.10.13 cdo
# and activate
conda ativate py310
# install the software
pip install optim_esm_tools

You should be ready to go!

Testing installation (optional)

After installation, you could test that everything is properly installed and all the dependencies are working.

# Clone https://github.com/JoranAngevaare/optim_esm_tools
git clone https://github.com/JoranAngevaare/optim_esm_tools.git
cd optim_esm_tools
pytest -v --durations 0

You could even test that all the notebooks work out of the box with the jupyter setup in your environment:

# Clone https://github.com/JoranAngevaare/optim_esm_tools
git clone https://github.com/JoranAngevaare/optim_esm_tools.git
cd optim_esm_tools
pip install -r requirements_tests.txt
pytest optim_esm_tools -v --nbmake -n3 notebooks/*.ipynb --durations 0

Extended setup (optional)

For downloading CMIP6 data, synda is a useful tool, and few routines work best with the associated the ESGF-file structure. Since synda list is only supported in python 3.8, we created a separate repository optim_esm_base that has a working set of software versions that are compatible with these requirements.

Alternatively, setting up a miniforge/conda environment is documented in optim_esm_base.

Example

In the notebooks folder, we have an example notebook to help you get started. More advanced tutorials are also available in the notebooks folder.

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

optim_esm_tools-5.0.0.tar.gz (88.7 kB view details)

Uploaded Source

Built Distribution

optim_esm_tools-5.0.0-py3-none-any.whl (182.7 kB view details)

Uploaded Python 3

File details

Details for the file optim_esm_tools-5.0.0.tar.gz.

File metadata

  • Download URL: optim_esm_tools-5.0.0.tar.gz
  • Upload date:
  • Size: 88.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for optim_esm_tools-5.0.0.tar.gz
Algorithm Hash digest
SHA256 db971e2f00083fde5d9ad1d988d66814213dcb825e058c5268316dde8b8f0125
MD5 a40518f264161ec46c549e9dd5c3fab8
BLAKE2b-256 ef40b2f27fa18dbddf813cde892502a77099845f3691809921a92276caaa0737

See more details on using hashes here.

File details

Details for the file optim_esm_tools-5.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for optim_esm_tools-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4fdbf2d8b5753a18341923991760fbe5cdb3987ae0d136ad84bba70e59e0683
MD5 12fadbcf7b52c246e68b2a1fb3bb6b89
BLAKE2b-256 9e3d3e6953ef368dc6649c077476b2cff3f45c469c756a0ddb710e99ec6dbb37

See more details on using hashes here.

Supported by

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