From 35e1abade32dc9b4d4ef14c437cb8be2c2b5ce86 Mon Sep 17 00:00:00 2001 From: Sceki Date: Tue, 3 Dec 2024 19:24:12 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20spaceml-?= =?UTF-8?q?org/karman@62f6bf0ccaa018f52d2b48066df11eeb45305227=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sources/tutorials.rst | 35 ++++++++++++++------------ searchindex.js | 2 +- tutorials.html | 56 ++++++++++++++++++++---------------------- 3 files changed, 46 insertions(+), 47 deletions(-) diff --git a/_sources/tutorials.rst b/_sources/tutorials.rst index fc1f399..cffe778 100644 --- a/_sources/tutorials.rst +++ b/_sources/tutorials.rst @@ -14,42 +14,45 @@ Note that these procedures can take quite some RAM & CPU time. * Data downloading: for this, you have to go in the `scripts/input_data_prep` and run the following commands (note, if you want to download the data for specific dates, or onto specific directories, you can pass the arguments, e.g. --output_dir path/to/dir, and similar, as preferred): + .. code-block:: console - $ python download_tudelft_thermo.py - $ python download_sw_indices.py - $ python download_omniweb.py - $ python download_goes.py - $ python download_soho.py + $ python download_tudelft_thermo.py + $ python download_sw_indices.py + $ python download_omniweb.py + $ python download_goes.py + $ python download_soho.py We also run the NRLMSISE-00 model and collect the output for both the nowcasting and forecasting model (note that if you want to change input/output path to directories, or configurations of the parallel processing, you can do so by specifying the arguments): + .. code-block:: console - $ python run_nrlmsise00.py - $ python run_nrlmsise00_time_series.py + $ python run_nrlmsise00.py + $ python run_nrlmsise00_time_series.py Once this is done, you can start the pre-processing. * Data pre-processing: for this, you have to go in the `scripts/input_data_prep` and run the following commands (note, if you want to pre-process the data onto specific directories, e.g. --output_dir path/to/dir you can do so by specifying the argument): - .. code-block:: console - $ python process_tudelft_data.py - $ python process_sw_indices.py - $ python process_omniweb_data.py - $ python process_goes_data.py - $ python process_soho_data.py + .. code-block:: console + $ python process_tudelft_data.py + $ python process_sw_indices.py + $ python process_omniweb_data.py + $ python process_goes_data.py + $ python process_soho_data.py * Data merging: for this, you have to go in the `scripts/input_data_prep` and run the following commands (note, if you want to merge the data onto specific directories, e.g. --output_dir path/to/dir you can do so by specifying the argument): + .. code-block:: console - - $ python merge_omni_data.py - $ python merge_sw_and_tudelft_data.py + + $ python merge_omni_data.py + $ python merge_sw_and_tudelft_data.py Basics diff --git a/searchindex.js b/searchindex.js index 532ba59..452d32f 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API": [[0, null]], "Advanced": [[8, "advanced"]], "Basics": [[8, "basics"]], "Capabilities": [[1, null]], "Contents": [[3, null]], "Credits": [[2, null]], "Data Analysis": [[5, null]], "Data Inputs Download and Preprocessing": [[8, "data-inputs-download-and-preprocessing"]], "Data Preparation": [[6, "data-preparation"], [7, "data-preparation"]], "Forecasting Data": [[5, "forecasting-data"]], "Forecasting Tutorial": [[6, null]], "Getting Started": [[3, null]], "Getting help": [[4, "getting-help"]], "Imports": [[5, "imports"], [6, "imports"], [7, "imports"]], "Installation": [[4, null]], "Installation from source": [[4, "installation-from-source"]], "Karman Documentation": [[3, null]], "NRLMSISE-00 Data": [[6, "nrlmsise-00-data"], [7, "nrlmsise-00-data"]], "Nowcasting Data": [[5, "nowcasting-data"]], "Nowcasting Tutorial": [[7, null]], "Small Deep Neural Network Nowcasting Model": [[7, "small-deep-neural-network-nowcasting-model"]], "Time Fusion Transformer Forecasting Model": [[6, "time-fusion-transformer-forecasting-model"]], "Tutorials": [[8, null]], "Visualization": [[6, "visualization"]]}, "docnames": ["api", "capabilities", "credits", "index", "install", "notebooks/data_analysis", "notebooks/tutorial_forecast", "notebooks/tutorial_nowcast", "tutorials"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "capabilities.ipynb", "credits.ipynb", "index.md", "install.rst", "notebooks/data_analysis.ipynb", "notebooks/tutorial_forecast.ipynb", "notebooks/tutorial_nowcast.ipynb", "tutorials.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [4, 5, 6, 7], "0": [5, 6, 7], "00": [5, 8], "000000": 5, "0048": 5, "01": 5, "02": 5, "0202": 5, "0342e": 5, "05": [5, 6, 7], "07": 5, "08": 7, "1": [5, 6, 7], "100": [5, 6, 7], "10000": [5, 6], "12": [5, 6, 7], "128": 7, "145": 6, "1492": 5, "14_params_35585": 7, "15": 5, "150": 5, "1767": 5, "18": [5, 6, 7], "1e": [6, 7], "1e3": [6, 7], "2": [6, 7], "200": 5, "2000": 5, "2021": 2, "2023": 2, "2024": [2, 5, 6, 7], "2036273": 5, "216": 7, "23": [5, 6], "24": 5, "2454e": 5, "250km": [6, 7], "27": 5, "2705": 5, "2774e": 5, "289457": 6, "29": 5, "3": [5, 6, 7], "300000": 6, "31": [5, 6], "3186": 5, "32": [5, 6], "35585": 7, "3x128": 7, "40": 5, "4357": 5, "450": 5, "450000": 7, "4559": 5, "4697": 5, "47": [5, 7], "48": 5, "4965": 5, "5": [6, 7], "50": 6, "500": 5, "5696": 5, "59": [5, 7], "5971": 5, "7": 5, "7113": 5, "7433": 5, "7742": 5, "8007": 5, "8900": 5, "906_params_289457": 6, "9627": 5, "9998": 5, "A": 2, "And": [2, 4, 5], "As": 5, "For": 5, "If": [4, 5], "In": [5, 6, 7], "It": [1, 2, 3, 6, 7], "The": [2, 3, 5], "There": 5, "These": [5, 8], "To": 8, "Will": 2, "_co": 5, "_sin": 5, "absolut": 5, "access": 5, "acciarini": [2, 3], "activ": [4, 5], "actual": 6, "add": 5, "add_safe_glob": [6, 7], "advisor": 2, "after": 2, "aishwarya": 2, "all": 5, "all__dates_datetime__": [5, 6], "all__day_of_year__": 5, "all__seconds_in_day__": 5, "all__year__": [5, 6], "allow": [6, 7], "allowlist": [6, 7], "alreadi": 6, "also": [1, 2, 5, 6, 7, 8], "altitud": [5, 6, 7], "altitude_bin": 5, "an": [1, 4, 6, 7], "analysi": 8, "angl": 5, "ani": [6, 7], "ap": [5, 6, 7], "ap_averag": 5, "api": 3, "append": [5, 6, 7], "ar": [2, 3, 5, 6, 7, 8], "arbitrari": [6, 7], "arcco": [6, 7], "argument": [5, 8], "arrai": [5, 6, 7], "ask": 5, "attention_head": 6, "at\u0131l\u0131m": 2, "averag": 5, "ax": [5, 6, 7], "axi": [6, 7], "base": [4, 6], "baydin": 2, "becom": 5, "been": 5, "befor": [5, 6], "behavior": 5, "belong": 5, "benchmark": 5, "benson": 2, "berger": 2, "bernard": 2, "between": 5, "bin": 5, "blob": [6, 7], "block": 8, "bonasera": 2, "both": [3, 5, 8], "branch": 4, "bridg": 2, "brown": 2, "build": 6, "can": [5, 6, 8], "capabl": 3, "cartopi": [6, 7], "case": [5, 6, 7], "categori": 8, "ccr": [6, 7], "cd": 4, "celestrack__ap_average__": [5, 6, 7], "center": 5, "central_longitud": [6, 7], "chang": [5, 8], "chosen": 5, "chri": 2, "class": 5, "classif": 5, "clone": 4, "co": 5, "coastlin": [6, 7], "code": [6, 7, 8], "collect": 8, "column": 5, "column_nam": 5, "column_names_instantaneous_featur": 5, "com": [3, 4, 6, 7], "command": 8, "comparison": [5, 6, 7], "complex": 8, "comput": [6, 7], "conda": 4, "configur": 8, "connor": 2, "consol": 8, "construct": [6, 7], "contact": [3, 4], "contain": [3, 5], "continu": 2, "contributor": 2, "control": [6, 7], "correspond": 5, "could": [6, 7], "coupl": 6, "cpu": [6, 7, 8], "cr": [6, 7], "creat": [4, 5, 6, 7], "credit": 3, "csv": [5, 6], "current": [2, 6, 7], "d": [5, 6, 7], "data": [1, 3], "data_matrix": 5, "data_path": 6, "data_thermo": 5, "datafram": 5, "dataset": 5, "date": [5, 6, 7, 8], "date_start": 5, "datetim": 7, "default": [5, 6, 7], "defin": 6, "deg": 5, "densiti": [1, 2, 3, 5, 6, 7], "density_model": [6, 7], "density_nn": [6, 7], "density_nrlmsise00": [6, 7], "deriv": [3, 5, 6, 7], "describ": 5, "detail": [6, 7], "determin": [6, 7], "dev": 3, "develop": [2, 3, 4], "devic": [6, 7], "df_sw": [6, 7], "dict_kei": 5, "dictionari": 5, "differ": 3, "dir": 8, "directli": [6, 7], "directori": 8, "divid": 8, "divis": 2, "do": [4, 5, 7, 8], "doe": 5, "don": [6, 7], "done": [5, 8], "download": 1, "download_go": 8, "download_omniweb": 8, "download_soho": 8, "download_sw_indic": 8, "download_tudelft_thermo": 8, "drag": 2, "driven": [1, 3], "dtype": [5, 6, 7], "dump": 6, "dure": [2, 6, 7], "e": [4, 5, 7, 8], "easier": 5, "edward": 2, "either": [4, 5], "empir": 7, "entri": 6, "env": 4, "environ": 4, "eric": 2, "error": [5, 6, 7], "essenc": 7, "estim": 3, "etc": [5, 8], "euv": [3, 5], "event": 6, "everi": 5, "everyth": 5, "exampl": [5, 8], "except": 6, "exclud": 5, "execut": [6, 7], "experiment": [6, 7], "explicitli": [6, 7], "exponenti": 5, "exponential_atmospher": 5, "extra": 5, "extract": [6, 7], "f": [4, 6], "f10": 5, "f107": [6, 7], "f107a": [6, 7], "faculti": 2, "fals": [6, 7], "faster": 6, "fawcett": 2, "fdl": 2, "featur": [5, 6, 7], "features_to_exclude_omni_magnetic_field": 5, "features_to_exclude_thermo": [5, 6], "feed": 7, "few": [6, 7], "field": 5, "fig": [6, 7], "figsiz": [5, 6, 7], "figur": [6, 7], "file": [5, 6, 7], "find_sw_from_thermo": [6, 7], "finish": 5, "first": [5, 6, 7], "flatten": [6, 7], "flip": [6, 7], "float32": [6, 7], "follow": [2, 4, 5, 8], "font": 5, "forecast": [1, 3, 8], "forecasting_model": 6, "forecastingmodel": 6, "forward": 7, "framework": 8, "from": [1, 3, 5, 6, 7], "full": [6, 7], "function": [1, 6, 7], "fund": 2, "fusion": 3, "futur": [6, 7], "futurewarn": [6, 7], "g": [5, 7, 8], "g0": 5, "g1": 5, "ga00693": [6, 7], "gener": [6, 7], "geomagnet": [3, 5], "geomagnetic_storm_g_class": 5, "giacomo": [2, 3], "gilda": 2, "git": 4, "github": [4, 6, 7], "globe": [6, 7], "gmail": 3, "go": 8, "goe": [3, 5], "great": 2, "grid": [6, 7], "gridlin": [6, 7], "ground": 5, "ground_truth": 5, "g\u00fcne\u015f": 2, "ha": 5, "have": [5, 6, 7, 8], "heliophys": 2, "henc": 5, "here": [6, 7], "hern\u00e1ndez": 2, "hesit": 4, "hidden_lay": 7, "hidden_layer_dim": 7, "high": 5, "hist": 5, "home": [6, 7], "how": [5, 6, 7, 8], "howev": 5, "http": [4, 6, 7], "hyperparamet": 6, "hyunju": 2, "i": [1, 3, 4, 5, 6, 7, 8], "ij": [6, 7], "im2": [6, 7], "implicitli": [6, 7], "includ": [3, 5, 8], "index": [5, 6, 7], "indic": [3, 5], "info": 3, "inform": 5, "initi": 2, "input": [1, 3, 6, 7], "input_data_prep": 8, "insid": 5, "instal": 3, "instanc": 5, "instantaneous_featur": 5, "investig": 5, "irradi": 5, "issu": [4, 6, 7], "item": 5, "jah": 2, "jame": [2, 3], "jb": 7, "jb08__d_st_dt__": [5, 6], "jordi": 2, "jorg": 2, "k": [2, 5, 6], "karman": [0, 1, 2, 4, 5, 6, 7, 8], "karman_dataset": 5, "karman_model": 7, "karman_nowcast_model_log_exp_residual_valid_mape_15": 7, "karmandataset": 5, "keep": [6, 7], "kei": 5, "kept": 4, "kg": [5, 6], "km": 5, "know": 5, "kumar": 2, "lag": [5, 6], "lag_minut": 6, "lag_minutes_omni": 5, "last": [6, 7], "lat": [6, 7], "lat_grid": [6, 7], "latitud": [6, 7], "latter": 5, "learn": [1, 2, 3], "len": [6, 7], "less": 5, "let": [5, 6, 7], "leverag": [3, 8], "life": 5, "lightweight": 7, "like": [5, 6], "limit": [6, 7], "linspac": [6, 7], "list": [5, 6, 7], "load": [5, 6, 7], "load_model": [6, 7], "load_state_dict": [6, 7], "log10": 5, "lon": [6, 7], "lon_grid": [6, 7], "longer": [6, 7], "longitud": [5, 6, 7], "lonlat_grid": [6, 7], "look": 5, "m": [5, 6], "machin": [1, 3], "magnet": 5, "main": [3, 4, 6, 7], "make": [5, 6], "malici": [6, 7], "malik": 2, "mamba": 4, "map_loc": 6, "match": 5, "math": 6, "matplotlib": [5, 6, 7], "max": [5, 6, 7], "max_dat": 5, "md": [6, 7], "mean": 5, "meant": 5, "member": 2, "merg": 8, "merge_omni_data": 8, "merge_sw_and_tudelft_data": 8, "merged_dataset": 5, "merged_omni_indic": 6, "merged_omni_magnetic_field": [5, 6], "merged_omni_solar_wind": 6, "meshgrid": [6, 7], "meter": [6, 7], "might": 5, "min": [5, 6, 7], "min_dat": 5, "mind": [6, 7], "minut": [5, 6], "ml": [3, 6, 7], "mode": [6, 7], "model": [1, 3, 5, 8], "model_path": [6, 7], "model_path_t": 6, "moder": 5, "modul": [6, 7], "mollweid": [6, 7], "more": [3, 5, 6, 7, 8], "moriba": 2, "most": 5, "msise": 6, "msise_flat": [6, 7], "my": 5, "n_grid": [6, 7], "n_sampl": [6, 7], "nasa": 2, "ncol": [6, 7], "necessari": 5, "need": 5, "next": 6, "nn": [6, 7], "non": 5, "normal": [4, 5, 6], "normalize_time_series_data": 6, "note": [5, 6, 8], "now": [5, 6, 7], "nowcast": [1, 3, 8], "nowcasting_model": 7, "nowcastingmodel": 7, "np": [6, 7], "nrlmsise": [5, 8], "nrlmsise00": [5, 6, 7], "nrlmsise00__thermospheric_density__": [5, 6], "nrlmsise00_data": 6, "nrlmsise00_time_seri": 6, "nrow": [6, 7], "nt": 5, "num_featur": 7, "num_instantaneous_featur": 7, "number": 6, "numpi": [5, 6, 7], "object": [5, 6, 7], "off": [6, 7], "offer": [1, 3], "omni": 5, "omni_indic": 6, "omni_magnetic_field": [5, 6], "omni_magnetic_field_path": 5, "omni_resolut": 5, "omni_solar_wind": 6, "omniweb": [3, 5], "omniweb__bx_gse__": 5, "omniweb__by_gse__": 5, "omniweb__bz_gse__": 5, "omniweb_data": [5, 6], "onc": 8, "one": [5, 6], "ones": 5, "onto": 8, "open": [1, 4, 6, 7], "orbit": [6, 7], "org": 4, "origin": [2, 5], "other": 5, "output": 8, "output_dir": 8, "packag": [1, 3], "panda": [5, 6, 7], "parallel": 8, "paramet": [6, 7], "particular": [5, 6], "pass": 8, "path": [5, 6, 7, 8], "pcolormesh": [6, 7], "pd": [5, 6, 7], "percentag": 5, "perez": 2, "pi": [6, 7], "pickl": [6, 7], "piecewis": 5, "pip": 4, "pk": [6, 7], "platecarre": [6, 7], "pleas": [4, 6, 7], "plot": [5, 6, 7], "plt": [5, 6, 7], "pod": [3, 5], "possibl": [6, 7], "pr": 4, "pre": [1, 6, 8], "precis": [6, 7], "predict": [6, 7], "prefer": 8, "preprocess": 6, "previou": 2, "print": 6, "procedur": 8, "process": [1, 8], "process_goes_data": 8, "process_omniweb_data": 8, "process_soho_data": 8, "process_sw_indic": 8, "process_tudelft_data": 8, "produc": 5, "project": [2, 6, 7], "properli": 5, "provid": 8, "proxi": 3, "purpos": 5, "py": [6, 7, 8], "pyplot": [5, 6, 7], "python": [3, 8], "pytorch": [6, 7], "p\u00e9rez": 2, "quantiletransform": 6, "queri": 5, "quit": 8, "rad2deg": [6, 7], "ram": 8, "random": 6, "randomsampl": 6, "ravel": [6, 7], "rb": 6, "rcparam": 5, "re": 5, "recommend": [6, 7], "redund": 5, "rel": [6, 7], "relat": [6, 7], "releas": [6, 7], "remov": [5, 6, 7], "report": 4, "research": 2, "reshap": [6, 7], "resolut": [5, 6], "resolution_minut": 6, "rest": 5, "retriev": 5, "right": 5, "run": [4, 6, 7, 8], "run_nrlmsise00": 8, "run_nrlmsise00_time_seri": 8, "same": [5, 7], "sampl": 5, "sankalp": 2, "satellit": [6, 7], "satellites_data_w_sw_2mln": 5, "scaler": 5, "scipi": 5, "script": 8, "second": [6, 7], "secur": [6, 7], "see": [5, 6, 7], "sequentialsampl": 6, "seri": [5, 6], "serial": [6, 7], "set": [5, 6, 7, 8], "set_default_dtyp": [6, 7], "set_glob": [6, 7], "set_titl": [6, 7], "setup": [6, 7], "sever": [1, 3], "shape": 5, "show": [5, 6, 7], "shreshth": 2, "similar": 8, "simpl": 8, "simplic": 5, "sin": 5, "size": 5, "sklearn": 6, "so": [6, 8], "soho": [3, 5, 6], "soho_data": 6, "solar": [2, 3, 5], "solar_activity_bin": 5, "some": [5, 8], "somewher": 5, "sort": [6, 7], "sourc": [1, 3], "space_environment_technologies__f107_average__": [5, 6, 7], "space_environment_technologies__f107_obs__": [5, 6, 7], "space_environment_technologies__m107_average__": [5, 6], "space_environment_technologies__m107_obs__": [5, 6], "space_environment_technologies__s107_average__": [5, 6], "space_environment_technologies__s107_obs__": [5, 6], "space_environment_technologies__y107_average__": [5, 6], "space_environment_technologies__y107_obs__": [5, 6], "spaceml": 4, "spare": 6, "specif": 8, "specifi": 8, "split": 6, "stack": [6, 7], "start": [5, 6, 7, 8], "state": 4, "state_s": 6, "stefano": 2, "store": [5, 6], "storm": 5, "subplot": [6, 7], "subplot_kw": [6, 7], "support": [3, 5], "sutton": 2, "sw": [6, 7], "sw_df": [6, 7], "sy": [5, 6, 7], "symmetr": 5, "t": [6, 7], "take": [6, 8], "target": 5, "task": 8, "team": 2, "tensor": 5, "term": 5, "tft": 6, "thei": [5, 6, 7], "thermo": 5, "thermo_path": 5, "thermospher": [1, 2, 3, 5, 6, 7], "thi": [5, 6, 7, 8], "thing": [5, 6], "thoma": 2, "those": 5, "thousand": 7, "three": [2, 8], "thu": 4, "time": [3, 5, 8], "time_series_data": 5, "titl": 5, "to_datetim": [5, 6, 7], "to_pydatetim": [6, 7], "top": [6, 7], "torch": [5, 6, 7], "train": [1, 5, 6, 7], "transform": [3, 7], "troubl": 4, "true": [6, 7], "truth": 5, "try": 6, "ts_data_norm": 6, "ts_karman_model": 6, "ts_karman_model_tft_ss32_heads5_lag10000_resolution100_valid_mape_15": 6, "tudelft_thermo__altitude__": 5, "tudelft_thermo__ground_truth_thermospheric_density__": [5, 6], "tudelft_thermo__latitude__": 5, "tudelft_thermo__longitude__": 5, "tudelft_thermo__satellite__": [5, 6], "tutori": [3, 5], "two": 5, "u": [4, 6, 7], "under": 8, "unless": [6, 7], "unpickl": [6, 7], "untrust": [6, 7], "up": 6, "updat": 5, "us": [4, 5, 6, 7, 8], "user": [5, 6, 7], "usual": [4, 6], "util": [6, 7], "v": [6, 7], "valu": [5, 6, 7], "variabl": 5, "variou": 1, "veri": [2, 7], "via": [4, 6, 7], "vila": 2, "vmax": [6, 7], "vmin": [6, 7], "wa": [2, 5], "walsh": [2, 3], "want": [5, 8], "wavelength": 5, "wb": 6, "we": [2, 4, 5, 6, 7, 8], "weights_onli": [6, 7], "well": [1, 5], "were": 2, "what": 5, "when": 5, "where": [6, 7], "wherea": 5, "which": [5, 6, 7], "while": [5, 6], "william": 2, "wind": 5, "without": 5, "work": [2, 4, 5], "workflow": 4, "x": [6, 7], "y": [5, 6], "yml": 4, "you": [4, 6, 7, 8]}, "titles": ["API", "Capabilities", "Credits", "Karman Documentation", "Installation", "Data Analysis", "Forecasting Tutorial", "Nowcasting Tutorial", "Tutorials"], "titleterms": {"00": [6, 7], "advanc": 8, "analysi": 5, "api": 0, "basic": 8, "capabl": 1, "content": 3, "credit": 2, "data": [5, 6, 7, 8], "deep": 7, "document": 3, "download": 8, "forecast": [5, 6], "from": 4, "fusion": 6, "get": [3, 4], "help": 4, "import": [5, 6, 7], "input": 8, "instal": 4, "karman": 3, "model": [6, 7], "network": 7, "neural": 7, "nowcast": [5, 7], "nrlmsise": [6, 7], "prepar": [6, 7], "preprocess": 8, "small": 7, "sourc": 4, "start": 3, "time": 6, "transform": 6, "tutori": [6, 7, 8], "visual": 6}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API": [[0, null]], "Advanced": [[8, "advanced"]], "Basics": [[8, "basics"]], "Capabilities": [[1, null]], "Contents": [[3, null]], "Credits": [[2, null]], "Data Analysis": [[5, null]], "Data Inputs Download and Preprocessing": [[8, "data-inputs-download-and-preprocessing"]], "Data Preparation": [[6, "data-preparation"], [7, "data-preparation"]], "Forecasting Data": [[5, "forecasting-data"]], "Forecasting Tutorial": [[6, null]], "Getting Started": [[3, null]], "Getting help": [[4, "getting-help"]], "Imports": [[5, "imports"], [6, "imports"], [7, "imports"]], "Installation": [[4, null]], "Installation from source": [[4, "installation-from-source"]], "Karman Documentation": [[3, null]], "NRLMSISE-00 Data": [[6, "nrlmsise-00-data"], [7, "nrlmsise-00-data"]], "Nowcasting Data": [[5, "nowcasting-data"]], "Nowcasting Tutorial": [[7, null]], "Small Deep Neural Network Nowcasting Model": [[7, "small-deep-neural-network-nowcasting-model"]], "Time Fusion Transformer Forecasting Model": [[6, "time-fusion-transformer-forecasting-model"]], "Tutorials": [[8, null]], "Visualization": [[6, "visualization"]]}, "docnames": ["api", "capabilities", "credits", "index", "install", "notebooks/data_analysis", "notebooks/tutorial_forecast", "notebooks/tutorial_nowcast", "tutorials"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "capabilities.ipynb", "credits.ipynb", "index.md", "install.rst", "notebooks/data_analysis.ipynb", "notebooks/tutorial_forecast.ipynb", "notebooks/tutorial_nowcast.ipynb", "tutorials.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [4, 5, 6, 7], "0": [5, 6, 7], "00": [5, 8], "000000": 5, "0048": 5, "01": 5, "02": 5, "0202": 5, "0342e": 5, "05": [5, 6, 7], "07": 5, "08": 7, "1": [5, 6, 7], "100": [5, 6, 7], "10000": [5, 6], "12": [5, 6, 7], "128": 7, "145": 6, "1492": 5, "14_params_35585": 7, "15": 5, "150": 5, "1767": 5, "18": [5, 6, 7], "1e": [6, 7], "1e3": [6, 7], "2": [6, 7], "200": 5, "2000": 5, "2021": 2, "2023": 2, "2024": [2, 5, 6, 7], "2036273": 5, "216": 7, "23": [5, 6], "24": 5, "2454e": 5, "250km": [6, 7], "27": 5, "2705": 5, "2774e": 5, "289457": 6, "29": 5, "3": [5, 6, 7], "300000": 6, "31": [5, 6], "3186": 5, "32": [5, 6], "35585": 7, "3x128": 7, "40": 5, "4357": 5, "450": 5, "450000": 7, "4559": 5, "4697": 5, "47": [5, 7], "48": 5, "4965": 5, "5": [6, 7], "50": 6, "500": 5, "5696": 5, "59": [5, 7], "5971": 5, "7": 5, "7113": 5, "7433": 5, "7742": 5, "8007": 5, "8900": 5, "906_params_289457": 6, "9627": 5, "9998": 5, "A": 2, "And": [2, 4, 5], "As": 5, "For": 5, "If": [4, 5], "In": [5, 6, 7], "It": [1, 2, 3, 6, 7], "The": [2, 3, 5], "There": 5, "These": [5, 8], "To": 8, "Will": 2, "_co": 5, "_sin": 5, "absolut": 5, "access": 5, "acciarini": [2, 3], "activ": [4, 5], "actual": 6, "add": 5, "add_safe_glob": [6, 7], "advisor": 2, "after": 2, "aishwarya": 2, "all": 5, "all__dates_datetime__": [5, 6], "all__day_of_year__": 5, "all__seconds_in_day__": 5, "all__year__": [5, 6], "allow": [6, 7], "allowlist": [6, 7], "alreadi": 6, "also": [1, 2, 5, 6, 7, 8], "altitud": [5, 6, 7], "altitude_bin": 5, "an": [1, 4, 6, 7], "analysi": 8, "angl": 5, "ani": [6, 7], "ap": [5, 6, 7], "ap_averag": 5, "api": 3, "append": [5, 6, 7], "ar": [2, 3, 5, 6, 7, 8], "arbitrari": [6, 7], "arcco": [6, 7], "argument": [5, 8], "arrai": [5, 6, 7], "ask": 5, "attention_head": 6, "at\u0131l\u0131m": 2, "averag": 5, "ax": [5, 6, 7], "axi": [6, 7], "base": [4, 6], "baydin": 2, "becom": 5, "been": 5, "befor": [5, 6], "behavior": 5, "belong": 5, "benchmark": 5, "benson": 2, "berger": 2, "bernard": 2, "between": 5, "bin": 5, "blob": [6, 7], "bonasera": 2, "both": [3, 5, 8], "branch": 4, "bridg": 2, "brown": 2, "build": 6, "can": [5, 6, 8], "capabl": 3, "cartopi": [6, 7], "case": [5, 6, 7], "categori": 8, "ccr": [6, 7], "cd": 4, "celestrack__ap_average__": [5, 6, 7], "center": 5, "central_longitud": [6, 7], "chang": [5, 8], "chosen": 5, "chri": 2, "class": 5, "classif": 5, "clone": 4, "co": 5, "coastlin": [6, 7], "code": [6, 7], "collect": 8, "column": 5, "column_nam": 5, "column_names_instantaneous_featur": 5, "com": [3, 4, 6, 7], "command": 8, "comparison": [5, 6, 7], "complex": 8, "comput": [6, 7], "conda": 4, "configur": 8, "connor": 2, "construct": [6, 7], "contact": [3, 4], "contain": [3, 5], "continu": 2, "contributor": 2, "control": [6, 7], "correspond": 5, "could": [6, 7], "coupl": 6, "cpu": [6, 7, 8], "cr": [6, 7], "creat": [4, 5, 6, 7], "credit": 3, "csv": [5, 6], "current": [2, 6, 7], "d": [5, 6, 7], "data": [1, 3], "data_matrix": 5, "data_path": 6, "data_thermo": 5, "datafram": 5, "dataset": 5, "date": [5, 6, 7, 8], "date_start": 5, "datetim": 7, "default": [5, 6, 7], "defin": 6, "deg": 5, "densiti": [1, 2, 3, 5, 6, 7], "density_model": [6, 7], "density_nn": [6, 7], "density_nrlmsise00": [6, 7], "deriv": [3, 5, 6, 7], "describ": 5, "detail": [6, 7], "determin": [6, 7], "dev": 3, "develop": [2, 3, 4], "devic": [6, 7], "df_sw": [6, 7], "dict_kei": 5, "dictionari": 5, "differ": 3, "dir": 8, "directli": [6, 7], "directori": 8, "divid": 8, "divis": 2, "do": [4, 5, 7, 8], "doe": 5, "don": [6, 7], "done": [5, 8], "download": 1, "download_go": 8, "download_omniweb": 8, "download_soho": 8, "download_sw_indic": 8, "download_tudelft_thermo": 8, "drag": 2, "driven": [1, 3], "dtype": [5, 6, 7], "dump": 6, "dure": [2, 6, 7], "e": [4, 5, 7, 8], "easier": 5, "edward": 2, "either": [4, 5], "empir": 7, "entri": 6, "env": 4, "environ": 4, "eric": 2, "error": [5, 6, 7], "essenc": 7, "estim": 3, "etc": [5, 8], "euv": [3, 5], "event": 6, "everi": 5, "everyth": 5, "exampl": [5, 8], "except": 6, "exclud": 5, "execut": [6, 7], "experiment": [6, 7], "explicitli": [6, 7], "exponenti": 5, "exponential_atmospher": 5, "extra": 5, "extract": [6, 7], "f": [4, 6], "f10": 5, "f107": [6, 7], "f107a": [6, 7], "faculti": 2, "fals": [6, 7], "faster": 6, "fawcett": 2, "fdl": 2, "featur": [5, 6, 7], "features_to_exclude_omni_magnetic_field": 5, "features_to_exclude_thermo": [5, 6], "feed": 7, "few": [6, 7], "field": 5, "fig": [6, 7], "figsiz": [5, 6, 7], "figur": [6, 7], "file": [5, 6, 7], "find_sw_from_thermo": [6, 7], "finish": 5, "first": [5, 6, 7], "flatten": [6, 7], "flip": [6, 7], "float32": [6, 7], "follow": [2, 4, 5, 8], "font": 5, "forecast": [1, 3, 8], "forecasting_model": 6, "forecastingmodel": 6, "forward": 7, "framework": 8, "from": [1, 3, 5, 6, 7], "full": [6, 7], "function": [1, 6, 7], "fund": 2, "fusion": 3, "futur": [6, 7], "futurewarn": [6, 7], "g": [5, 7, 8], "g0": 5, "g1": 5, "ga00693": [6, 7], "gener": [6, 7], "geomagnet": [3, 5], "geomagnetic_storm_g_class": 5, "giacomo": [2, 3], "gilda": 2, "git": 4, "github": [4, 6, 7], "globe": [6, 7], "gmail": 3, "go": 8, "goe": [3, 5], "great": 2, "grid": [6, 7], "gridlin": [6, 7], "ground": 5, "ground_truth": 5, "g\u00fcne\u015f": 2, "ha": 5, "have": [5, 6, 7, 8], "heliophys": 2, "henc": 5, "here": [6, 7], "hern\u00e1ndez": 2, "hesit": 4, "hidden_lay": 7, "hidden_layer_dim": 7, "high": 5, "hist": 5, "home": [6, 7], "how": [5, 6, 7, 8], "howev": 5, "http": [4, 6, 7], "hyperparamet": 6, "hyunju": 2, "i": [1, 3, 4, 5, 6, 7, 8], "ij": [6, 7], "im2": [6, 7], "implicitli": [6, 7], "includ": [3, 5, 8], "index": [5, 6, 7], "indic": [3, 5], "info": 3, "inform": 5, "initi": 2, "input": [1, 3, 6, 7], "input_data_prep": 8, "insid": 5, "instal": 3, "instanc": 5, "instantaneous_featur": 5, "investig": 5, "irradi": 5, "issu": [4, 6, 7], "item": 5, "jah": 2, "jame": [2, 3], "jb": 7, "jb08__d_st_dt__": [5, 6], "jordi": 2, "jorg": 2, "k": [2, 5, 6], "karman": [0, 1, 2, 4, 5, 6, 7, 8], "karman_dataset": 5, "karman_model": 7, "karman_nowcast_model_log_exp_residual_valid_mape_15": 7, "karmandataset": 5, "keep": [6, 7], "kei": 5, "kept": 4, "kg": [5, 6], "km": 5, "know": 5, "kumar": 2, "lag": [5, 6], "lag_minut": 6, "lag_minutes_omni": 5, "last": [6, 7], "lat": [6, 7], "lat_grid": [6, 7], "latitud": [6, 7], "latter": 5, "learn": [1, 2, 3], "len": [6, 7], "less": 5, "let": [5, 6, 7], "leverag": [3, 8], "life": 5, "lightweight": 7, "like": [5, 6], "limit": [6, 7], "linspac": [6, 7], "list": [5, 6, 7], "load": [5, 6, 7], "load_model": [6, 7], "load_state_dict": [6, 7], "log10": 5, "lon": [6, 7], "lon_grid": [6, 7], "longer": [6, 7], "longitud": [5, 6, 7], "lonlat_grid": [6, 7], "look": 5, "m": [5, 6], "machin": [1, 3], "magnet": 5, "main": [3, 4, 6, 7], "make": [5, 6], "malici": [6, 7], "malik": 2, "mamba": 4, "map_loc": 6, "match": 5, "math": 6, "matplotlib": [5, 6, 7], "max": [5, 6, 7], "max_dat": 5, "md": [6, 7], "mean": 5, "meant": 5, "member": 2, "merg": 8, "merge_omni_data": 8, "merge_sw_and_tudelft_data": 8, "merged_dataset": 5, "merged_omni_indic": 6, "merged_omni_magnetic_field": [5, 6], "merged_omni_solar_wind": 6, "meshgrid": [6, 7], "meter": [6, 7], "might": 5, "min": [5, 6, 7], "min_dat": 5, "mind": [6, 7], "minut": [5, 6], "ml": [3, 6, 7], "mode": [6, 7], "model": [1, 3, 5, 8], "model_path": [6, 7], "model_path_t": 6, "moder": 5, "modul": [6, 7], "mollweid": [6, 7], "more": [3, 5, 6, 7, 8], "moriba": 2, "most": 5, "msise": 6, "msise_flat": [6, 7], "my": 5, "n_grid": [6, 7], "n_sampl": [6, 7], "nasa": 2, "ncol": [6, 7], "necessari": 5, "need": 5, "next": 6, "nn": [6, 7], "non": 5, "normal": [4, 5, 6], "normalize_time_series_data": 6, "note": [5, 6, 8], "now": [5, 6, 7], "nowcast": [1, 3, 8], "nowcasting_model": 7, "nowcastingmodel": 7, "np": [6, 7], "nrlmsise": [5, 8], "nrlmsise00": [5, 6, 7], "nrlmsise00__thermospheric_density__": [5, 6], "nrlmsise00_data": 6, "nrlmsise00_time_seri": 6, "nrow": [6, 7], "nt": 5, "num_featur": 7, "num_instantaneous_featur": 7, "number": 6, "numpi": [5, 6, 7], "object": [5, 6, 7], "off": [6, 7], "offer": [1, 3], "omni": 5, "omni_indic": 6, "omni_magnetic_field": [5, 6], "omni_magnetic_field_path": 5, "omni_resolut": 5, "omni_solar_wind": 6, "omniweb": [3, 5], "omniweb__bx_gse__": 5, "omniweb__by_gse__": 5, "omniweb__bz_gse__": 5, "omniweb_data": [5, 6], "onc": 8, "one": [5, 6], "ones": 5, "onto": 8, "open": [1, 4, 6, 7], "orbit": [6, 7], "org": 4, "origin": [2, 5], "other": 5, "output": 8, "output_dir": 8, "packag": [1, 3], "panda": [5, 6, 7], "parallel": 8, "paramet": [6, 7], "particular": [5, 6], "pass": 8, "path": [5, 6, 7, 8], "pcolormesh": [6, 7], "pd": [5, 6, 7], "percentag": 5, "perez": 2, "pi": [6, 7], "pickl": [6, 7], "piecewis": 5, "pip": 4, "pk": [6, 7], "platecarre": [6, 7], "pleas": [4, 6, 7], "plot": [5, 6, 7], "plt": [5, 6, 7], "pod": [3, 5], "possibl": [6, 7], "pr": 4, "pre": [1, 6, 8], "precis": [6, 7], "predict": [6, 7], "prefer": 8, "preprocess": 6, "previou": 2, "print": 6, "procedur": 8, "process": [1, 8], "process_goes_data": 8, "process_omniweb_data": 8, "process_soho_data": 8, "process_sw_indic": 8, "process_tudelft_data": 8, "produc": 5, "project": [2, 6, 7], "properli": 5, "provid": 8, "proxi": 3, "purpos": 5, "py": [6, 7, 8], "pyplot": [5, 6, 7], "python": [3, 8], "pytorch": [6, 7], "p\u00e9rez": 2, "quantiletransform": 6, "queri": 5, "quit": 8, "rad2deg": [6, 7], "ram": 8, "random": 6, "randomsampl": 6, "ravel": [6, 7], "rb": 6, "rcparam": 5, "re": 5, "recommend": [6, 7], "redund": 5, "rel": [6, 7], "relat": [6, 7], "releas": [6, 7], "remov": [5, 6, 7], "report": 4, "research": 2, "reshap": [6, 7], "resolut": [5, 6], "resolution_minut": 6, "rest": 5, "retriev": 5, "right": 5, "run": [4, 6, 7, 8], "run_nrlmsise00": 8, "run_nrlmsise00_time_seri": 8, "same": [5, 7], "sampl": 5, "sankalp": 2, "satellit": [6, 7], "satellites_data_w_sw_2mln": 5, "scaler": 5, "scipi": 5, "script": 8, "second": [6, 7], "secur": [6, 7], "see": [5, 6, 7], "sequentialsampl": 6, "seri": [5, 6], "serial": [6, 7], "set": [5, 6, 7, 8], "set_default_dtyp": [6, 7], "set_glob": [6, 7], "set_titl": [6, 7], "setup": [6, 7], "sever": [1, 3], "shape": 5, "show": [5, 6, 7], "shreshth": 2, "similar": 8, "simpl": 8, "simplic": 5, "sin": 5, "size": 5, "sklearn": 6, "so": [6, 8], "soho": [3, 5, 6], "soho_data": 6, "solar": [2, 3, 5], "solar_activity_bin": 5, "some": [5, 8], "somewher": 5, "sort": [6, 7], "sourc": [1, 3], "space_environment_technologies__f107_average__": [5, 6, 7], "space_environment_technologies__f107_obs__": [5, 6, 7], "space_environment_technologies__m107_average__": [5, 6], "space_environment_technologies__m107_obs__": [5, 6], "space_environment_technologies__s107_average__": [5, 6], "space_environment_technologies__s107_obs__": [5, 6], "space_environment_technologies__y107_average__": [5, 6], "space_environment_technologies__y107_obs__": [5, 6], "spaceml": 4, "spare": 6, "specif": 8, "specifi": 8, "split": 6, "stack": [6, 7], "start": [5, 6, 7, 8], "state": 4, "state_s": 6, "stefano": 2, "store": [5, 6], "storm": 5, "subplot": [6, 7], "subplot_kw": [6, 7], "support": [3, 5], "sutton": 2, "sw": [6, 7], "sw_df": [6, 7], "sy": [5, 6, 7], "symmetr": 5, "t": [6, 7], "take": [6, 8], "target": 5, "task": 8, "team": 2, "tensor": 5, "term": 5, "tft": 6, "thei": [5, 6, 7], "thermo": 5, "thermo_path": 5, "thermospher": [1, 2, 3, 5, 6, 7], "thi": [5, 6, 7, 8], "thing": [5, 6], "thoma": 2, "those": 5, "thousand": 7, "three": [2, 8], "thu": 4, "time": [3, 5, 8], "time_series_data": 5, "titl": 5, "to_datetim": [5, 6, 7], "to_pydatetim": [6, 7], "top": [6, 7], "torch": [5, 6, 7], "train": [1, 5, 6, 7], "transform": [3, 7], "troubl": 4, "true": [6, 7], "truth": 5, "try": 6, "ts_data_norm": 6, "ts_karman_model": 6, "ts_karman_model_tft_ss32_heads5_lag10000_resolution100_valid_mape_15": 6, "tudelft_thermo__altitude__": 5, "tudelft_thermo__ground_truth_thermospheric_density__": [5, 6], "tudelft_thermo__latitude__": 5, "tudelft_thermo__longitude__": 5, "tudelft_thermo__satellite__": [5, 6], "tutori": [3, 5], "two": 5, "u": [4, 6, 7], "under": 8, "unless": [6, 7], "unpickl": [6, 7], "untrust": [6, 7], "up": 6, "updat": 5, "us": [4, 5, 6, 7, 8], "user": [5, 6, 7], "usual": [4, 6], "util": [6, 7], "v": [6, 7], "valu": [5, 6, 7], "variabl": 5, "variou": 1, "veri": [2, 7], "via": [4, 6, 7], "vila": 2, "vmax": [6, 7], "vmin": [6, 7], "wa": [2, 5], "walsh": [2, 3], "want": [5, 8], "wavelength": 5, "wb": 6, "we": [2, 4, 5, 6, 7, 8], "weights_onli": [6, 7], "well": [1, 5], "were": 2, "what": 5, "when": 5, "where": [6, 7], "wherea": 5, "which": [5, 6, 7], "while": [5, 6], "william": 2, "wind": 5, "without": 5, "work": [2, 4, 5], "workflow": 4, "x": [6, 7], "y": [5, 6], "yml": 4, "you": [4, 6, 7, 8]}, "titles": ["API", "Capabilities", "Credits", "Karman Documentation", "Installation", "Data Analysis", "Forecasting Tutorial", "Nowcasting Tutorial", "Tutorials"], "titleterms": {"00": [6, 7], "advanc": 8, "analysi": 5, "api": 0, "basic": 8, "capabl": 1, "content": 3, "credit": 2, "data": [5, 6, 7, 8], "deep": 7, "document": 3, "download": 8, "forecast": [5, 6], "from": 4, "fusion": 6, "get": [3, 4], "help": 4, "import": [5, 6, 7], "input": 8, "instal": 4, "karman": 3, "model": [6, 7], "network": 7, "neural": 7, "nowcast": [5, 7], "nrlmsise": [6, 7], "prepar": [6, 7], "preprocess": 8, "small": 7, "sourc": 4, "start": 3, "time": 6, "transform": 6, "tutori": [6, 7, 8], "visual": 6}}) \ No newline at end of file diff --git a/tutorials.html b/tutorials.html index d8ed298..31a6596 100644 --- a/tutorials.html +++ b/tutorials.html @@ -370,46 +370,42 @@

Data Inputs Download and Preprocessing
$ python download_tudelft_thermo.py
+$ python download_sw_indices.py
+$ python download_omniweb.py
+$ python download_goes.py
+$ python download_soho.py
+
+

We also run the NRLMSISE-00 model and collect the output for both the nowcasting and forecasting model (note that -if you want to change input/output path to directories, or configurations of the parallel processing, you can do so by specifying the arguments): -.. code-block:: console

-
-

$ python run_nrlmsise00.py -$ python run_nrlmsise00_time_series.py

-
+if you want to change input/output path to directories, or configurations of the parallel processing, you can do so by specifying the arguments):

+
$ python run_nrlmsise00.py
+$ python run_nrlmsise00_time_series.py
+
+

Once this is done, you can start the pre-processing.

  • Data pre-processing: for this, you have to go in the scripts/input_data_prep and run the following commands (note, if you want to pre-process the data onto specific directories, e.g. –output_dir path/to/dir -you can do so by specifying the argument): -.. code-block:: console

    -
    -

    $ python process_tudelft_data.py -$ python process_sw_indices.py -$ python process_omniweb_data.py -$ python process_goes_data.py -$ python process_soho_data.py

    -
    +you can do so by specifying the argument):

    +
    $ python process_tudelft_data.py
+$ python process_sw_indices.py
+$ python process_omniweb_data.py
+$ python process_goes_data.py
+$ python process_soho_data.py
+
    +

  • Data merging: for this, you have to go in the scripts/input_data_prep and run the following commands (note, if you want to merge the data onto specific directories, e.g. –output_dir path/to/dir -you can do so by specifying the argument): -.. code-block:: console

    -
    -

    $ python merge_omni_data.py -$ python merge_sw_and_tudelft_data.py

    -
    +you can do so by specifying the argument):

    +
    $ python merge_omni_data.py
+$ python merge_sw_and_tudelft_data.py
+
    +