Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix shown example with bundled examples cli cmd #187

Merged
merged 4 commits into from
Dec 8, 2022

Conversation

leifdenby
Copy link
Contributor

@leifdenby leifdenby commented Dec 7, 2022

Fix example shown when running python -m lagtraj.input_definitions.examples CLI command. Previously the returned command wasn't valid.

Currently on master:

$> python -m lagtraj.input_definitions.examples
The following domain/forcing/trajectory definitions are currently included with lagtraj:

lagtraj://
 ├── domains
 │   ├── eurec4a_north_atlantic
 │   ├── eurec4a_circle
 │   └── drydown_cardington_local
 ├── trajectories
 │   ├── eurec4a_20200103_lag_testcase
 │   ├── eurec4a_20200202_first_short_press
 │   ├── eurec4a_20200202_first
 │   ├── eurec4a_20200209_first
 │   ├── drydown_cardington_20200420_00_eul
 │   ├── eurec4a_20200205_second
 │   ├── eurec4a_20200207_first
 │   ├── eurec4a_campaign_eulerian
 │   ├── eurec4a_20200128_first
 │   ├── eurec4a_20200202_first_short_eul
 │   └── eurec4a_20200202_first_short
 ├── forcings_conversion
 │   ├── dephy_prescribed_rad
 │   ├── kpt__120_levels
 │   ├── kpt
 │   └── dephy
 └── forcings
     ├── eurec4a_20200103_lag_testcase
     ├── eurec4a_20200202_first_short_press
     ├── eurec4a_20200202_first
     ├── eurec4a_20200209_first
     ├── drydown_cardington_20200420_00_eul
     ├── eurec4a_20200205_second
     ├── eurec4a_20200207_first
     ├── eurec4a_campaign_eulerian
     ├── eurec4a_20200128_first
     ├── eurec4a_20200202_first_short_eul
     └── eurec4a_20200202_first_short


To use for example the `eurec4a_north_atlantic` domain definition
for downloading domain data run lagtraj.domain.download as follows:

    $> python -m lagtraj.domain.download lagtraj://eurec4a_20200202_first

The suggested command at the bottom is missing the start_date and end_date arguments, and eurec4a_20200202_first isn't a valid domain example.

Fix example shown when running `python -m
lagtraj.input_definitions.examples` CLI command. Previously the returned
command wasn't valid.
@leifdenby
Copy link
Contributor Author

With the fix the first domain is always used, and I've added the missing arguments:

$> python -m lagtraj.input_definitions.examples
The following domain/forcing/trajectory definitions are currently included with lagtraj:

lagtraj://
 ├── domains
 │   ├── eurec4a_north_atlantic
 │   ├── eurec4a_circle
 │   └── drydown_cardington_local
 ├── trajectories
 │   ├── eurec4a_20200103_lag_testcase
 │   ├── eurec4a_20200202_first_short_press
 │   ├── eurec4a_20200202_first
 │   ├── eurec4a_20200209_first
 │   ├── drydown_cardington_20200420_00_eul
 │   ├── eurec4a_20200205_second
 │   ├── eurec4a_20200207_first
 │   ├── eurec4a_campaign_eulerian
 │   ├── eurec4a_20200128_first
 │   ├── eurec4a_20200202_first_short_eul
 │   └── eurec4a_20200202_first_short
 ├── forcings_conversion
 │   ├── dephy_prescribed_rad
 │   ├── kpt__120_levels
 │   ├── kpt
 │   └── dephy
 └── forcings
     ├── eurec4a_20200103_lag_testcase
     ├── eurec4a_20200202_first_short_press
     ├── eurec4a_20200202_first
     ├── eurec4a_20200209_first
     ├── drydown_cardington_20200420_00_eul
     ├── eurec4a_20200205_second
     ├── eurec4a_20200207_first
     ├── eurec4a_campaign_eulerian
     ├── eurec4a_20200128_first
     ├── eurec4a_20200202_first_short_eul
     └── eurec4a_20200202_first_short


To use for example the `eurec4a_north_atlantic` domain definition
for downloading domain data for Feb 1st to 3rd 2020 run lagtraj.domain.download as follows:

    $> python -m lagtraj.domain.download lagtraj://eurec4a_north_atlantic 2020/02/01 2020/02/03

@leifdenby leifdenby merged commit 52e20db into EUREC4A-UK:master Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant