{"openapi":"3.0.2","info":{"title":"B0B1qModel API","description":"\nB0B1 qModel API  🚀\n\n\n## Endpoints\n\nYou will be able to run the [B0B1 quiet Model (B0B1qModel)](https://www.sciencedirect.com/science/article/abs/pii/S0273117708006455) to obtain B0 and B1 coefficients.\n\n* **Generate csv files**\n    * Time series file for a given year: month, hour, latitude, longitude, B0 (km), B1 (dimensionless)\n    * Heatmap snapshot file for a given year, month an hour at a specified spatial window: month, hour, latitude, longitude, B0 (km), B1 (dimensionless)\n    \n* **Generate plots of B0 (km)**\n    * Time series plot for a given year\n    * Heatmap snapshot\n    * Heatmap daily animation \n    \nNotes: \n* Values of B1 are provided in data files but they are not shown in the plots.\n* **Model validity**: The model is able to perform predictions until 2030 (not included).\n* The International Geomagnetic Reference Field (IGRF) used in this model is valid until 2025 (included). Note that those predictions for years between 2026 and 2029 (both included) can be computed but IGRF values may be of reduced accuracy.                  \n","version":"0.1.0"},"servers":[{"url":"/thickness_API"}],"paths":{"/B0B1qModel_time_series_file/":{"get":{"tags":["Time series file B0B1qModel"],"summary":"B0B1qModel Time Series File Response","operationId":"B0B1qModel_time_series_file_B0B1qModel_time_series_file__get","parameters":[{"description":"Insert a year in range [1900,2030)","required":false,"schema":{"title":"Year","type":"integer","description":"Insert a year in range [1900,2030)","default":2000},"name":"year","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Latitude","type":"number","description":"Insert a latitude in range [-70,+70]","default":40.8},"name":"latitude","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Longitude","type":"number","description":"Insert a longitude in range [-180,+180]","default":0.5},"name":"longitude","in":"query"}],"responses":{"200":{"description":"Successful Response"}}}},"/B0B1qModel_time_series_plot/":{"get":{"tags":["Time series plot B0B1qModel"],"summary":"B0B1qModel Time Series Plot","operationId":"B0B1qModel_time_series_plot_B0B1qModel_time_series_plot__get","parameters":[{"description":"Insert a year in range [1900,2030)","required":false,"schema":{"title":"Year","type":"integer","description":"Insert a year in range [1900,2030)","default":2000},"name":"year","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Latitude","type":"number","description":"Insert a latitude in range [-70,+70]","default":40.8},"name":"latitude","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Longitude","type":"number","description":"Insert a longitude in range [-180,+180]","default":0.5},"name":"longitude","in":"query"}],"responses":{"200":{"description":"Successful Response"}}}},"/B0B1qModel_map_file/":{"get":{"tags":["Heatmap snapshot file B0B1qModel"],"summary":"B0B1qModel Map File","operationId":"B0B1qModel_map_file_B0B1qModel_map_file__get","parameters":[{"description":"Insert a year in range [1900,2030)","required":false,"schema":{"title":"Year","type":"integer","description":"Insert a year in range [1900,2030)","default":2000},"name":"year","in":"query"},{"description":"Insert a month in range [1,12]","required":false,"schema":{"title":"Month","type":"integer","description":"Insert a month in range [1,12]","default":12},"name":"month","in":"query"},{"description":"Insert an hour in range [0,23]","required":false,"schema":{"title":"Hour","type":"integer","description":"Insert an hour in range [0,23]","default":23},"name":"hour","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Min","type":"number","description":"Insert a latitude in range [-70,+70]","default":30},"name":"lat_min","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Max","type":"number","description":"Insert a latitude in range [-70,+70]","default":70},"name":"lat_max","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Min","type":"number","description":"Insert a longitude in range [-180,+180]","default":-15},"name":"lon_min","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Max","type":"number","description":"Insert a longitude in range [-180,+180]","default":40},"name":"lon_max","in":"query"}],"responses":{"200":{"description":"Successful Response"}}}},"/B0B1qModel_map/":{"get":{"tags":["Heatmap snapshot B0B1qModel"],"summary":"B0B1qModel Map File","operationId":"B0B1qModel_map_B0B1qModel_map__get","parameters":[{"description":"Insert a year in range [1900,2030)","required":false,"schema":{"title":"Year","type":"integer","description":"Insert a year in range [1900,2030)","default":2000},"name":"year","in":"query"},{"description":"Insert a month in range [1,12]","required":false,"schema":{"title":"Month","type":"integer","description":"Insert a month in range [1,12]","default":12},"name":"month","in":"query"},{"description":"Insert an hour in range [0,23]","required":false,"schema":{"title":"Hour","type":"integer","description":"Insert an hour in range [0,23]","default":23},"name":"hour","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Min","type":"number","description":"Insert a latitude in range [-70,+70]","default":30},"name":"lat_min","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Max","type":"number","description":"Insert a latitude in range [-70,+70]","default":70},"name":"lat_max","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Min","type":"number","description":"Insert a longitude in range [-180,+180]","default":-15},"name":"lon_min","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Max","type":"number","description":"Insert a longitude in range [-180,+180]","default":40},"name":"lon_max","in":"query"}],"responses":{"200":{"description":"Successful Response"}}}},"/B0B1qModel_map_gif/":{"get":{"tags":["Heatmap daily animation B0B1qModel"],"summary":"B0B1qModel Map Gif","operationId":"hmf2_map_gif_B0B1qModel_map_gif__get","parameters":[{"description":"Insert a year in range [1900,2030)","required":false,"schema":{"title":"Year","type":"integer","description":"Insert a year in range [1900,2030)","default":2000},"name":"year","in":"query"},{"description":"Insert a month in range [1,12]","required":false,"schema":{"title":"Month","type":"integer","description":"Insert a month in range [1,12]","default":12},"name":"month","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Min","type":"number","description":"Insert a latitude in range [-70,+70]","default":30},"name":"lat_min","in":"query"},{"description":"Insert a latitude in range [-70,+70]","required":false,"schema":{"title":"Lat Max","type":"number","description":"Insert a latitude in range [-70,+70]","default":70},"name":"lat_max","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Min","type":"number","description":"Insert a longitude in range [-180,+180]","default":-15},"name":"lon_min","in":"query"},{"description":"Insert a longitude in range [-180,+180]","required":false,"schema":{"title":"Lon Max","type":"number","description":"Insert a longitude in range [-180,+180]","default":40},"name":"lon_max","in":"query"}],"responses":{"200":{"description":"Successful Response"}}}}},"components":{"schemas":{"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}},"tags":[{"name":"Time series file B0B1qModel","description":"Returns a csv file for the monthly averages of the thickness model coefficients (B0,B1) at different hours"},{"name":"Time series plot B0B1qModel","description":"Returns a plot for the monthly averages of the thickness model coefficient B0 (km)s at different hours"},{"name":"Heatmap snapshot file B0B1qModel","description":"Returns a csv file for different latitudes and longitudes of the monthly averaged Thickness model coefficients (B0,B1) at an hour for a certain spatial time window"},{"name":"Heatmap snapshot B0B1qModel","description":"Returns a heatmap of the monthly averaged Thickness model B0 coefficient (km) at an hour for a certain spatial time window"},{"name":"Heatmap daily animation B0B1qModel","description":"Returns an hourly animation of the monthly averaged monthly averaged Thickness model B0 coefficient (km) for a certain spatial time window.  The execution may take a while ⌚. You can go for a coffee if you want 🍵."}]}