|
|
## Installation
|
|
|
|
|
|
On a computer with anaconda, you can set up an environment for the AIT Framework Quicklooks software by doing the following:
|
|
|
First clone a copy of the AITF_FW_Quicklooks repository.
|
|
|
|
|
|
We have moved to recommending [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge) as our installation tool. Once you have Mambaforge installed, use the following commands to create your environment.
|
|
|
|
|
|
```bash
|
|
|
conda create -n aitf_ql python=3.6 anaconda
|
|
|
source activate aitf_ql
|
|
|
conda install netcdf4 scipy pillow
|
|
|
conda install -c conda-forge cartopy
|
|
|
mamba create -n aitf_ql python=3.8 netcdf4 scipy pillow cartopy
|
|
|
mamba activate aitf_ql
|
|
|
```
|
|
|
|
|
|
Now, with your aitf_ql environment active, run the following in the AIT_FW_Quicklooks directory:
|
|
|
|
|
|
```bash
|
|
|
python setup.py develop
|
|
|
```
|
|
|
|
|
|
(Please note, we intend to move away from easy_install in future, so this step may change.)
|
|
|
|
|
|
You should now be able to use the aitf_ql command on your command line.
|
|
|
|
|
|
### Running the Software
|
|
|
|
|
|
Each time you want to use the quicklooks software in a new session you will need to run
|
|
|
|
|
|
```
|
|
|
mamba activate aitf_ql
|
|
|
```
|
|
|
|
|
|
If you want to deactivate the aitf_ql environment you can run
|
|
|
|
|
|
```
|
|
|
mamba deactivate
|
|
|
```
|
|
|
|
|
|
The AIT Framework Quicklooks software uses standard command line arguments to specify most of the information that it needs:
|
|
|
|
|
|
```
|
|
|
usage: aitf_ql [-h] [--image_size WIDTH HEIGHT] [-o OUTPUT_DIR] [-O OUTPUT_FILE_PREFIX] [-S STRIDE] [--customrange CUSTOM_DATA_RANGE] [--rawrange] [--fileloadedrange] [--no-convert] [--onlyvar ONLY_VAR_NAME]
|
|
|
[--unnavigated] [--dataonly] [-v] [-V]
|
|
|
input_files [input_files ...]
|
|
|
|
|
|
Create quicklooks plots from CSPP Geo NetCDF product file.
|
|
|
|
|
|
positional arguments:
|
|
|
input_files Paths to one or more CSPP Geo NetCDF product files. If a directory is given, the program will examine all files in that directory to see if they are appropriate. This argument will also expand meta-
|
|
|
characters understood by python's glob module (including *, ?, and +, among others). Please see the documentation for glob for specific syntax.
|
|
|
|
|
|
optional arguments:
|
|
|
-h, --help show this help message and exit
|
|
|
--image_size WIDTH HEIGHT
|
|
|
The size of the output image [*width*, *height*] in pixels. User input will be rounded to the nearest 10 pixels. [default: '[2000.0, 1600.0]']
|
|
|
-o OUTPUT_DIR, --output_dir OUTPUT_DIR
|
|
|
The directory where the generated quicklooks images will be put.
|
|
|
-O OUTPUT_FILE_PREFIX, --output_file_prefix OUTPUT_FILE_PREFIX
|
|
|
String to prepend to the automatically generated png names. [default: ]
|
|
|
-S STRIDE, --stride STRIDE
|
|
|
Sample every STRIDE rows and columns in the data, where stride is specified as a positive integer. By default or if you pass in a negative number the software will generate a stride automatically to
|
|
|
decrease your data size to near the output image size (in pixels). If you want to plot all the data, pass in 1 for the stride. Warning: Plotting all the data can cause slow plotting and high memory
|
|
|
usage for large data sets.
|
|
|
--customrange CUSTOM_DATA_RANGE
|
|
|
Use a custom range for plotting quicklooks. The range should be defined using the syntax min:max and will be applied to all quicklooks generated during this run. By default the quicklooks will be
|
|
|
plotted with a colorbar using custom range limits for some variables and the valid_range attributes for other variables. If --customrange and --rawrange are both present, the custom range will be
|
|
|
used. If --customrange and --fileloadedrange are both present, the custom range will be used.
|
|
|
--rawrange Do not pay attention to the valid range or any flag information, just display the colormap using the raw data range. By default the quicklooks will be plotted with a colorbar using custom range
|
|
|
limits for some variables and the valid_range attributes for other variables. If --rawrange and --customrange are both present, the custom range will be used. If --rawrange and --fileloadedrange are
|
|
|
both present, the raw range will be used.
|
|
|
--fileloadedrange Use the range data in the valid_range attribute given in the attributes in the data file for plotting quicklooks. By default the quicklooks will be plotted with a colorbar using custom range limits
|
|
|
for some variables and the valid_range attributes for other variables. If --customrange and --fileloadedrange are both present, the custom range will be used. if --rawrange and --fileloadedrange are
|
|
|
both included in the command line call, the raw range will be used.
|
|
|
--no-convert Do not convert level one radiance data to reflectances or brightness temperatures.
|
|
|
--onlyvar ONLY_VAR_NAME
|
|
|
Process only the variable name given. No other variables from the input files will be used to make quicklooks. If your variable name has spaces use single quotes around it.
|
|
|
--unnavigated Do not navigate the data on a map, just display it as an image.
|
|
|
--dataonly Plot the data at full resolution and nothing else. No labeling or navigation will appear in the output images.
|
|
|
-v, --verbosity each occurrence increases verbosity 1 level. If you do not include this argument the verbosity will default to INFO. -v=ERROR -vv=WARNING -vvv=INFO -vvvv=DEBUG
|
|
|
-V, --version Print the CSPP FW Quicklooks package version
|
|
|
```
|
|
|
|
|
|
----------------------------
|
|
|
|
|
|
_**Please note: The below are older installation instructions and may no longer work.**_
|
|
|
|
|
|
## Minimal installation
|
|
|
|
|
|
This is a minimal installation into a virtualenv, not relying on Anaconda. Tested on Ubuntu 16.04 by Alan De Smet, January 2018
|
... | ... | |