Input4MIPs-validation

Validation of input4MIPs data (checking file formats, metadata etc.).

PyPI :

Other info :

Installation

Input4MIPs-validation can be installed with pip, mamba or conda:

pip install input4mips-validation
mamba install -c conda-forge input4mips-validation
conda install -c conda-forge input4mips-validation

Additional dependencies can be installed using

# To add plotting dependencies
pip install input4mips-validation[plots]
# To add notebook dependencies
pip install input4mips-validation[notebooks]

# If you are installing with conda, we recommend
# installing the extras by hand because there is no stable
# solution yet (issue here: https://github.com/conda/conda/issues/7502)

For developers

For development, we rely on poetry for all our dependency management. To get started, you will need to make sure that poetry is installed (instructions here, we found that pipx and pip worked better to install on a Mac).

For all of work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see Development.

Contents

• Command-line interface
  • input4mips-validation
• Notebooks
  • Basic demos
  • Notebook execution info
• Development
  • Workflows
  • Language
  • Versioning
  • Releasing
  • Read the Docs
• API Reference
  • input4mips_validation.attrs_helpers
  • input4mips_validation.cli
  • input4mips_validation.controlled_vocabularies
  • input4mips_validation.dataset
  • input4mips_validation.exceptions
  • input4mips_validation.metadata
  • input4mips_validation.testing
  • input4mips_validation.time
  • input4mips_validation.validation
  • input4mips_validation.xarray_helpers
• Changelog
  • input4mips-validation v0.3.1 (2024-04-23)
  • input4mips-validation v0.3.0 (2024-04-23)
  • input4mips-validation v0.2.1 (2024-02-15)
  • input4mips-validation v0.2.0 (2024-02-09)
  • input4mips-validation v0.1.1 (2024-02-06)

Index

• :ref:genindex

• :ref:modindex

• :ref:search