Input4MIPs-validation

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

Key info :

PyPI :

Conda :

Tests :

Other info :

Full documentation can be found at: input4mips-validation.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

As an application

If you want to use input4MIPs-validation as an application, for example you just want to use its command-line interface, then we recommend using the 'locked' version of the package. This version pins the version of all dependencies too, which reduces the chance of installation issues because of breaking updates to dependencies.

The locked version of input4mips-validation can be installed with

# pip: https://pip.pypa.io/en/stable/
pip install input4mips-validation[locked]
# mamba: https://mamba.readthedocs.io/en/latest/
mamba install -c conda-forge input4mips-validation-locked
# conda: https://docs.conda.io/projects/conda/en/stable/
conda install -c conda-forge input4mips-validation-locked

As a library

If you want to use input4MIPs-validation as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below. This method provides the loosest pins possible of all dependencies. This gives you, the package/application developer, as much freedom as possible to set the versions of different packages. However, the tradeoff with this freedom is that you may install incompatible versions of input4mips-validation's dependencies (we cannot test all combinations of dependencies, particularly ones which haven't been released yet!). Hence, you may run into installation issues. If you believe these are because of a problem in input4mips-validation, please raise an issue.

The (non-locked) version of input4mips-validation can be installed with

# pip: https://pip.pypa.io/en/stable/
pip install input4mips-validation
# mamba: https://mamba.readthedocs.io/en/latest/
mamba install -c conda-forge input4mips-validation
# conda: https://docs.conda.io/projects/conda/en/stable/
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 pixi for all our dependency management. To get started, you will need to make sure that pixi is installed (instructions here).

We rely on pdm for managing our PyPI builds. Hence, you will also need to make sure that pdm is installed on your system (instructions here, although we found that installing with pipx worked perfectly for us).

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][development-reference].