diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 3042dc7..63bdf53 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -31,6 +31,24 @@ Command line interface (CLI) --month \ +Setting Environment Variables +----------------------------- + +Before running the `synop2bufr data transform` command, you need to set the `BUFR_ORIGINATING_CENTRE` and `BUFR_ORIGINATING_SUBCENTRE` environment variables. These variables are used to specify the originating centre and subcentre of the SYNOP messages. Without these set, the conversion will fail. + +It is recommended that you set these environment variables in the Dockerfile, by editing the lines `ENV BUFR_ORIGINATING_CENTRE=` and `ENV BUFR_ORIGINATING_SUBCENTRE=`. + +Alternatively, you can set these environment variables in your shell if you want to run synop2bufr on your local machine. Here's how you can do it in a Bash shell: + +.. code-block:: shell + + export BUFR_ORIGINATING_CENTRE= + export BUFR_ORIGINATING_SUBCENTRE= + +Replace `` and `` with the appropriate values for your use case. + +Now, you can run the `synop2bufr data transform` command as described in the previous section. + Input FM-12 file (input-fm12.txt) --------------------------------- The FM-12 input data format is described in the `WMO Manual on Codes, Volume I.1 `__.