11# VISION-toolkit-v2-development
22
3- ** Development towards Version 2 of the VISION project toolkit**
3+ ** Version 2 of the VISION project toolkit**
44
5- :warning : Note this code is * actively under development* and no guarantees about
6- functionality or about documentation or testing can be made . For a released
7- earlier version of the toolkit, please see and use the tool provided in the
5+ :warning : Note this code is * under development though should be relatively stable now * , though
6+ there may be some changes . For a released earlier version of the toolkit, please see and
7+ use the tool provided in the
88[ ` VISION-toolkit ` ] ( https://github.com/NCAS-VISION/VISION-toolkit ) repository,
99and consult the documentation there. (When this code is ready it will be copied to that
1010repository as its canonical home and marked as Version 2.0 of the toolkit.) :warning :
1111
12+ ## Context
13+
14+ For context on this toolkit and its scientific and technical background, please consult
15+ [ these slides] ( https://github.com/sadielbartholomew/sadielbartholomew/blob/master/talks-and-workshops/VISION_UoR_Met_Dept_lunchtime_seminar.pdf )
16+ from a recent talk given by a VISION team member.
17+
1218## Instructions for setup and use
1319
1420### Installing the toolkit
@@ -19,31 +25,18 @@ repository as its canonical home and marked as Version 2.0 of the toolkit.) :war
1925 you can run and use the command ` visiontoolkit ` instead of having to call the script
2026 with the Python interpreter.
2127
22- 4 . The ** environment** you need will to run it requires a custom branch of
23- cf-plot, and otherwise you will need all the
24- dependencies of that and of cf-python. So, to get the right
25- Python environment (` conda ` and/or ` mamba ` will make it simplest):
26-
27- 1 . Ensure you are using Python version 3.10 or later.
28- 2 . Install the latest cf-python and cf-plot (noting in the latter case this
29- is mostly to ensure you have the right dependencies because we will
30- then go on to install a specific branch from cf-plot as below).
31- To do this, see the instructions at:
28+ 4 . The ** environment** you need will to run it requires the following:
3229
33- * https://ncas-cms.github.io/cf-python/installation.html
34- * https://ncas-cms.github.io/cf-plot/build/download.html#to-install-cf-plot
35-
36- 3 . You need the latest version of cf-plot on a specific branch where a special
37- bug-fix patch has been applied, so use the ` generalise-traj ` branch required
38- using the following command:
39- ` pip install git+https://github.com/NCAS-CMS/cf-plot.git@generalise-traj `
30+ 1 . Python version 3.10 or later;
31+ 2 . cf-python at a version of minimum of 3.17.0,
32+ see https://ncas-cms.github.io/cf-python/installation.html for guidance;
33+ 3 . cf-plot at a version of minimum 3.4.0, see https://ncas-cms.github.io/cf-plot/installation.html
34+ for guidance.
4035
4136
4237### Running the toolkit
4338
44- The script has now been given minimal packaging so it can be
45- run as a command after installation as per the above instructions. See the available
46- CLI from running:
39+ The script is packaged so it can be run as a command after installation as per the above instructions. See the available command-line interface from running:
4740
4841``` console
4942$ visiontoolkit --help
@@ -66,3 +59,10 @@ $ cd visiontoolkit
6659$ visiontoolkit --config-file=" configurations/wrf-faam-stanco-1.json"
6760```
6861
62+ The above examples are of flight trajectories. A satellite observation case example is:
63+
64+ ``` console
65+ $ cd visiontoolkit
66+ $ visiontoolkit --config-file=" configurations/um-satellite-1.json"
67+ ```
68+
0 commit comments