diff --git a/README.md b/README.md index b994852..c336f35 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ File-checking made simple + +## Documentation + +See the [Read The Docs page](https://checksit.readthedocs.io/en/latest) for more +details on how to install and run checksit. + +Visit the [JASMIN help page](https://help.jasmin.ac.uk/docs/software-on-jasmin/community-software-checksit/) +for guidance on how to use checksit on JASMIN. + + ## Installation Create a venv, then install, either directly from GitHub: @@ -20,113 +30,16 @@ pip install . ## Usage -A brief description of how to use checksit is given here. For more detail, visit the [documentation site](https://checksit.readthedocs.io/en/latest). - -checksit is comprised of four key components - [check](#checksit-check), [describe](#checksit-describe), [show-specs](#checksit-show-specs), and [summary](#checksit-summary) - +A brief description of how to use checksit is given here. For more detail, visit the +[documentation site](https://checksit.readthedocs.io/en/latest). -## checksit check +### checksit check -Check file against a template. - -### Basic Usage +To check a file: ``` checksit check /badc/ukcp18/data/land-cpm/uk/2.2km/rcp85/01/rss/day/latest/rss_rcp85_land-cpm_uk_2.2km_01_day_20671201-20681130.nc ``` -* Checks format of file. -* checksit searches its template cache for a similar file to compare against - - -### Main Features - -#### Define template -``` -checksit check --template=template-cache/rls_rcp85_land-cpm_uk_2.2km_01_day_19801201-19811130.cdl /badc/ukcp18/data/land-cpm/uk/2.2km/rcp85/01/rss/day/latest/rss_rcp85_land-cpm_uk_2.2km_01_day_20671201-20681130.nc -``` -* Use `--template` flag to define a template to use -* Template can be in template-cache or any file user has access to -* Note: cdl files are a representation of a netCDF file, being the output from `ncdump -h` on the netCDF file - - -#### Map variable names -``` -checksit check -m cltAnom=cloud_area_fraction /gws/nopw/j04/cmip6_prep_vol1/ukcp18/data/land-prob/v20211110/uk/25km/rcp85/sample/b8110/30y/cltAnom/mon/v20211110/cltAnom_rcp85_land-prob_uk_25km_sample_b8110_30y_mon_20091201-20991130.nc -``` -* Allows mapping of variable name, for the case that the name of a variable is different between the file to be checked and the template -* Format - `-m