Further minor fixes

Author: pont-us

CONTRIBUTING.md

@@ -35,7 +35,7 @@ checklist are addressed in your PR.
 
 The `zappend` code compliant to [PEP-8](https://pep8.org/) except for a line 
 length of 88 characters as recommended by [black](https://black.readthedocs.io/).
-Since back is un-opinionated regarding the order of imports, 
+Since black is un-opinionated regarding the order of imports, 
 we use the following three import blocks separated by an empty 
 line:
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Brockmann Consult Development
+Copyright (c) 2023–2024 Brockmann Consult Development
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/guide.md

@@ -41,7 +41,7 @@ function, the slice datasets can be provided in various forms. More on this is g
 in section [_Slice Sources_](#slice-sources) below.
 
 To run the `zappend` tool with [configuration](config.md) you can pass one or more
-configuration files using JSON or YAML format
+configuration files using JSON or YAML format:
 
 ```shell
 zappend -t output/mycube.zarr -c config.yaml inputs/*.nc
@@ -50,13 +50,13 @@ zappend -t output/mycube.zarr -c config.yaml inputs/*.nc
 If multiple configuration files are passed, they will be merged into one by
 incrementally updating the first by subsequent ones. 
 
-You can pass configuration settings to the `zappend` Python function by the optional
-`config` keyword argument. Other keyword arguments are interpreted as individual 
-configuration settings and will be merged into the one given by `config` argument,
-if any. The `config` keyword argument can be given as local file path or URL 
-(type `str`) pointing to a JSON or YAML file. It can also be given as dictionary,
-or as a sequence of the aforementioned types. Configuration sequences are again merged
-into one.
+You can pass configuration settings to the `zappend` Python function with 
+the optional `config` keyword argument. Other keyword arguments are 
+interpreted as individual configuration settings and will be merged into the 
+one given by `config` argument, if any. The `config` keyword argument can be 
+given as local file path or URL (type `str`) pointing to a JSON or YAML file.
+It can also be given as dictionary, or as a sequence of the aforementioned 
+types. Configuration sequences are again merged into one.
 
 ```python
 import os
@@ -82,9 +82,10 @@ This remainder of this guide explains the how to use the various `zappend`
 ## Dataset Outline
 
 If no further configuration is supplied, then the target dataset's outline and data 
-encoding is fully prescribed by the first slice dataset provided. By default, the 
-dimension along subsequent slice datasets are concatenated is `time`. If you use a 
-different append dimension, the `append_dim` setting can be used to specify its name:
+encoding is fully prescribed by the first slice dataset provided. By default, the
+dimension along which subsequent slice datasets are concatenated is `time`. If
+you use a different append dimension, the `append_dim` setting can be used to
+specify its name:
 
 ```json
 {
@@ -94,7 +95,7 @@ different append dimension, the `append_dim` setting can be used to specify its
 
 All other non-variadic dimensions can and should be specified using the
 `fixed_dims` setting which is a mapping from dimension name to the 
-fixed dimension sizes, e.g.:
+fixed dimension size, e.g.:
 
 ```json
 {
@@ -107,9 +108,9 @@ fixed dimension sizes, e.g.:
 
 By default, without further configuration, all data variables seen in the first
 dataset slice will be included in the target dataset. If only a subset of 
-variables shall be used from the slice dataset, they can be specified using the
-`included_variables` setting, which is a list of names of variables that will 
-be included:
+variables should be used from the slice dataset, they can be specified using
+the `included_variables` setting, which is a list of names of variables that
+will be included:
 
 ```json
 {
@@ -121,7 +122,7 @@ be included:
 }
 ```
 
-Often, it is easier to tell which variables should be excluded:
+Often, it is easier to specify which variables should be excluded:
 
 ```json
 {
@@ -156,13 +157,14 @@ values for all variables:
 }
 ```
 
-If `*` is specified, the effective variable metadata applied is gained by merging a 
-given specific metadata, into the common metadata given by `*`, which is eventually 
-merged into metadata of the variable in the first dataset slice.
+If `*` is specified, the metadata for a particular variable is generated by
+merging the specific metadata for that variable into the common metadata given
+by `*`, which is eventually merged into metadata of the variable in the first
+dataset slice.
 
 !!! note
-    Only metadata from the first slice dataset is used, metadata of variables from 
-    subsequent slice datasets is ignored entirely.
+    Only metadata from the first slice dataset is used. Metadata of variables
+    from subsequent slice datasets is ignored entirely.
 
 ### Dimensions
 

docs/start.md

@@ -2,12 +2,22 @@
 
 ## Installation
 
-Installing `zappend` into a Python v3.10+ environment:
+`zappend` requires a Python v3.10+ environment. To install the latest released
+version from PyPI:
 
 ```shell
 pip install zappend
 ```
 
+To install the latest version for development, clone the
+[repository](https://github.com/bcdev/zappend), and with the repository’s root
+directory as the current working directory execute:
+
+```shell
+pip install --editable .
+```
+
+
 ## Using the CLI
 
 Get usage help:
@@ -16,7 +26,7 @@ Get usage help:
 zappend --help
 ```
 
-Get [configuration](config.md) help: 
+Get [configuration](config.md) help in Markdown format (json also available):
 
 ```shell
 zappend --help-config md
@@ -64,5 +74,5 @@ zappend((f"s3:/mybucket/data/{name}"
         config=config)
 ```
 
-Slice datasets can be passed in a number of ways, please refer to the section 
+Slice datasets can be passed in a number of ways; please refer to the section 
 [_Slice Sources_](guide.md#slice-sources) in the [User Guide](guide.md).

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = zappend
-version = attr: zappend.version
+version = attr: zappend.__version__
 author = Norman Fomferra
 description = Tool for creating and updating a Zarr datacubes from smaller slices
 long_description = file: README.md

zappend/__init__.py

@@ -2,4 +2,4 @@
 # Permissions are hereby granted under the terms of the MIT License:
 # https://opensource.org/licenses/MIT.
 
-version = "0.2.1.dev0"
+__version__ = "0.2.1.dev0"