This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
other:python:jyp_steps [2023/12/15 14:45] jypeter [Data file formats] Added link to the NetCDF section |
other:python:jyp_steps [2024/03/07 10:15] jypeter Added a Protocol Buffers section to the file formats |
||
---|---|---|---|
Line 165: | Line 165: | ||
===== Using NetCDF files with Python ===== | ===== Using NetCDF files with Python ===== | ||
- | <note tip>People using CMIPn and model data on the IPSL servers can easily search and process NetCDF files using: | ||
- | * the [[https://climaf.readthedocs.io/|Climate Model Assessment Framework (CliMAF)]] environment | ||
- | * and the [[https://github.com/jservonnat/C-ESM-EP/wiki|CliMAF Earth System Evaluation Platform (C-ESM-EP)]] | ||
- | </note> | ||
- | * There is a good chance that your input array data will be stored in a [[other:newppl:starting#netcdf_and_related_conventions|NetCDF]] file. | + | ==== What is NetCDF? ==== |
+ | |||
+ | * If you are working with climate model output data, there is a good chance that your input array data will be stored in a NetCDF file! | ||
+ | |||
+ | * Read the [[other:newppl:starting#netcdf_and_related_conventions|NetCDF and related Conventions]] for more information | ||
* There may be different ways of dealing with NetCDF files, depending on which [[other:python:starting#some_python_distributions|python distribution]] you have access to | * There may be different ways of dealing with NetCDF files, depending on which [[other:python:starting#some_python_distributions|python distribution]] you have access to | ||
- | ==== cdms2 ==== | ||
- | Summary: cdms2 can read/write netCDF files (and read //grads// dat+ctl files) and provides a higher level interface than netCDF4. cdms2 is available in the [[other:python:starting#cdat|CDAT distribution]], and can theoretically be installed independently of CDAT (e.g. it will be installed when you install [[https://cmor.llnl.gov/mydoc_cmor3_conda/|CMOR in conda)]]. When you can use cdms2, you also have access to //cdtime//, that is very useful for handling time axis data. | + | ==== CliMAF and C-ESM-EP ==== |
+ | |||
+ | People using **//CMIPn// and model data on the IPSL servers** can easily search and process NetCDF files using: | ||
+ | |||
+ | * the [[https://climaf.readthedocs.io/|Climate Model Assessment Framework (CliMAF)]] environment | ||
+ | |||
+ | * and the [[https://github.com/jservonnat/C-ESM-EP/wiki|CliMAF Earth System Evaluation Platform (C-ESM-EP)]] | ||
- | How to get started: | ||
- | - read [[http://www.lsce.ipsl.fr/Phocea/file.php?class=page&file=5/pythonCDAT_jyp_2sur2_070306.pdf|JYP's cdms tutorial]], starting at page 54 | ||
- | - the tutorial is in French (soooorry!) | ||
- | - you have to replace //cdms// with **cdms2**, and //MV// with **MV2** (sooorry about that, the tutorial was written when CDAT was based on //Numeric// instead of //numpy// to handle array data) | ||
- | - read the [[http://cdms.readthedocs.io/en/docstanya/index.html|official cdms documentation]] (link may change) | ||
==== xarray ==== | ==== xarray ==== | ||
- | Summary: [[https://docs.xarray.dev/|xarray]] makes working with labelled multi-dimensional arrays in Python simple, efficient, and fun! [...] It is particularly tailored to working with netCDF files | + | [[https://docs.xarray.dev/|xarray]] makes working with labelled multi-dimensional arrays in Python simple, efficient, and fun! [...] It is particularly tailored to working with netCDF files |
=== Some xarray related resources === | === Some xarray related resources === | ||
Line 194: | Line 194: | ||
* [[https://docs.xarray.dev/en/stable/generated/xarray.tutorial.load_dataset.html|xarray test datasets]] | * [[https://docs.xarray.dev/en/stable/generated/xarray.tutorial.load_dataset.html|xarray test datasets]] | ||
- | * [[https://xcdat.readthedocs.io/|xcdat]]: xarray extended with Climate Data Analysis Tools | + | * **[[https://xcdat.readthedocs.io/|xCDAT]]: ''xarray'' extended with Climate Data Analysis Tools** |
* [[https://xoa.readthedocs.io/en/latest/|xoa]]: xarray-based ocean analysis library | * [[https://xoa.readthedocs.io/en/latest/|xoa]]: xarray-based ocean analysis library | ||
* [[https://uxarray.readthedocs.io/|uxarray]]: provide xarray styled functionality for unstructured grid datasets following [[https://ugrid-conventions.github.io/ugrid-conventions/|UGRID Conventions]] | * [[https://uxarray.readthedocs.io/|uxarray]]: provide xarray styled functionality for unstructured grid datasets following [[https://ugrid-conventions.github.io/ugrid-conventions/|UGRID Conventions]] | ||
- | |||
==== netCDF4 ==== | ==== netCDF4 ==== | ||
- | Summary: //netCDF4 can read/write netCDF files and is available in most python distributions// | + | [[http://unidata.github.io/netcdf4-python/|netCDF4]] is a Python interface to the netCDF C library |
- | Where: [[http://unidata.github.io/netcdf4-python/]] | ||
- | ===== CDAT-related resources ===== | + | ==== cdms2 ==== |
- | Some links, in case they can't be found easily on the [[https://cdat.llnl.gov|CDAT]] web site... | + | <note important> |
+ | * ''cdms2'' is unfortunately not maintained anymore and is slowly being **phased out in favor of a combination of [[#xarray|xarray]] and [[https://xcdat.readthedocs.io/|xCDAT]]** | ||
- | * [[https://cdat.llnl.gov/tutorials.html|Tutorials in ipython notebooks]] | + | * ''cdms2'' will [[https://github.com/CDAT/cdms/issues/449|not be compatible with numpy after numpy 1.23.5]] :-( |
- | * [[http://cdat-vcs.readthedocs.io/en/latest/|VCS: Visualization Control System]] | + | </note> |
- | * [[https://github.com/CDAT/vcs/issues/238|Colormaps in vcs examples]] | + | |
- | * [[https://github.com/CDAT/cdat-site/blob/master/eztemplate.md|EzTemplate Documentation]] | + | [[https://cdms.readthedocs.io/en/docstanya/|cdms2]] can read/write netCDF files (and read //grads// dat+ctl files) and provides a higher level interface than netCDF4. ''cdms2'' is available in the [[other:python:starting#cdat|CDAT distribution]], and can theoretically be installed independently of CDAT (e.g. it will be installed when you install [[https://cmor.llnl.gov/mydoc_cmor3_conda/|CMOR in conda)]]. When you can use cdms2, you also have access to //cdtime//, that is very useful for handling time axis data. |
+ | |||
+ | How to get started: | ||
+ | - read [[http://www.lsce.ipsl.fr/Phocea/file.php?class=page&file=5/pythonCDAT_jyp_2sur2_070306.pdf|JYP's cdms tutorial]], starting at page 54 | ||
+ | - the tutorial is in French (soooorry!) | ||
+ | - you have to replace //cdms// with **cdms2**, and //MV// with **MV2** (sooorry about that, the tutorial was written when CDAT was based on //Numeric// instead of //numpy// to handle array data) | ||
+ | - read the [[http://cdms.readthedocs.io/en/docstanya/index.html|official cdms documentation]] (link may change) | ||
===== Matplotlib ===== | ===== Matplotlib ===== | ||
Line 456: | Line 461: | ||
* [[https://github.com/LibraryOfCongress/bagger|Bagger]] (BagIt GUI) | * [[https://github.com/LibraryOfCongress/bagger|Bagger]] (BagIt GUI) | ||
* [[https://github.com/LibraryOfCongress/bagit-python|bagit-python]] | * [[https://github.com/LibraryOfCongress/bagit-python|bagit-python]] | ||
+ | |||
+ | ==== Protocol Buffers ==== | ||
+ | |||
+ | //Protocol Buffers are (Google's) language-neutral, platform-neutral extensible mechanisms for serializing structured data// | ||
+ | |||
+ | * https://protobuf.dev/ | ||
+ | * [[https://protobuf.dev/getting-started/pythontutorial/|Protocol Buffer Basics: Python]] | ||
+ | * ''mamba install protobuf'' | ||
===== Quick Reference and cheat sheets ===== | ===== Quick Reference and cheat sheets ===== | ||
Line 563: | Line 576: | ||
You can do a lot more with python! But if you have read at least a part of this page, you should be able to find and use the modules you need. Make sure you do not reinvent the wheel! Use existing packages when possible, and make sure to report bugs or errors in the documentations when you find some | You can do a lot more with python! But if you have read at least a part of this page, you should be able to find and use the modules you need. Make sure you do not reinvent the wheel! Use existing packages when possible, and make sure to report bugs or errors in the documentations when you find some | ||
+ | |||
+ | |||
+ | ===== Out-of-date stuff ===== | ||
+ | |||
+ | |||
+ | ==== CDAT-related resources ==== | ||
+ | |||
+ | Some links, in case they can't be found easily on the [[https://cdat.llnl.gov|CDAT]] web site... | ||
+ | |||
+ | * [[https://cdat.llnl.gov/tutorials.html|Tutorials in ipython notebooks]] | ||
+ | * [[http://cdat-vcs.readthedocs.io/en/latest/|VCS: Visualization Control System]] | ||
+ | * [[https://github.com/CDAT/vcs/issues/238|Colormaps in vcs examples]] | ||
+ | * [[https://github.com/CDAT/cdat-site/blob/master/eztemplate.md|EzTemplate Documentation]] | ||
+ | |||
/* standard page footer */ | /* standard page footer */ |