Create example JSON config(s)

Question

Create example JSON config(s)

CillianFn opened this issue 2 years ago · comments

Cillian Fennell commented 2 years ago

Similar to the *.cfg configuration file examples found in /configs, create example JSON config(s)

Alex Merose commented 2 years ago

xref: #48

Pranay Prajapati · Answer 1 · Tue Dec 28 2021 20:33:24 GMT+0800 (China Standard Time)

Hi, I am new to open source and I would like to work on this issue. Please guide me further on what needs to be done.

Cillian Fennell · Answer 2 · Wed Dec 29 2021 00:51:50 GMT+0800 (China Standard Time)

Hey @pranay101 ! More information can be found about what configuration files are used for here

As outlined, Configuration files can be written in *.cfg or *.json. However the examples in the config directory only contains examples of *.cfg files.

It would be useful to have some *.json examples also. I suggest creating json versions of some of the cfg examples. These can then be tested locally to ensure the same behaviour is observed e.g.

weather-dl configs/era5_example_config_local_run.cfg --local-run
should work the same as,
weather-dl configs/era5_example_config_local_run.json--local-run

Alex Merose · Answer 3 · Wed Dec 29 2021 07:37:50 GMT+0800 (China Standard Time)

I like the idea of having JSON configs. It's worth noting that the JSON representation will not be as full featured as the ConfigParser. See: https://github.com/google/weather-tools/blob/main/weather_dl/download_pipeline/parsers.py#L72

I think we can still create JSON example configs; however, these will have to be more verbose for the time being.

Pranay Prajapati · Answer 4 · Thu Dec 30 2021 00:05:45 GMT+0800 (China Standard Time)

Hey @pranay101 ! More information can be found about what configuration files are used for here

As outlined, Configuration files can be written in *.cfg or *.json. However the examples in the config directory only contains examples of *.cfg files.

It would be useful to have some *.json examples also. I suggest creating json versions of some of the cfg examples. These can then be tested locally to ensure the same behaviour is observed e.g.

weather-dl configs/era5_example_config_local_run.cfg --local-run should work the same as, weather-dl configs/era5_example_config_local_run.json--local-run

how should I structure the project then?. creating separate folders for .CFG and .JSON inside config. or should I place json file along with the cfg files.

Alex Merose · Answer 5 · Thu Dec 30 2021 09:32:21 GMT+0800 (China Standard Time)

I'm a fan of flat file structures. So, json next to cfg sounds good to me.