diff --git a/ANN_Training.py b/ANN_Training.py index aa51a908037464da87deeab070fa5402298ac2a6..e496df6601a44ef62d55458d04911a5bb5bc0186 100644 --- a/ANN_Training.py +++ b/ANN_Training.py @@ -5,8 +5,6 @@ Code-Style: E226, W503 Docstring-Style: D200, D400 -TODO: Add README for ANN training - """ import numpy as np import time diff --git a/DG_Approximation.py b/DG_Approximation.py index babce4bd72e0766f3e81964d9ea9b3a0060124e4..5434a6f5c2de84344162cdc9f60db0cfa2657017 100644 --- a/DG_Approximation.py +++ b/DG_Approximation.py @@ -15,13 +15,21 @@ TODO: Ask whether all quadratures depend on freely chosen num_nodes TODO: Contemplate saving training data for each IC separately TODO: Contemplate removing TrainingDataGenerator class TODO: Ask why no fine mesh is used for calculate_coarse_projection() +TODO: Discuss adding kwargs to attributes in documentation +TODO: Discuss descriptions (matrices, cfl number, right-hand side, + limiting slope, basis, wavelet, etc.) +TODO: Discuss referencing info on SSPRK3 TODO: Ask the meaning of the shifted bounds in Boxplot (Modified script) + -> Done (ignore for now) TODO: Ask whether the indices for the wavelet calculation are i or i+1 -TODO: Ask why wavelet matrix has unset ghost cells + -> Done (each cell is multiplied with left projection) +TODO: Ask why wavelet matrix has unset ghost cells -> Done (probably) Urgent: +TODO: Fix indexing issue in wavelet coefficient calculation TODO: Enforce mesh with 2^n cells +TODO: Enforce even number of ghost cells on each side on fine mesh (?) TODO: Change heaviside random to uniform(-100, 100) TODO: Adjust Heaviside to have non-symmetric values (left- and right_value) TODO: Rename 'adjustment' to 'shift' @@ -30,7 +38,7 @@ TODO: Give option to set discontinuity to cell boundary TODO: Fix typo in LinearAbsolute TODO: Introduce middle_factor for two-sided Heaviside TODO: Adapt TCD from Soraya - (Dropbox->...->TEST_troubled-cell-detector->Troubled_Cell_Detector) + (Dropbox->...->TEST_troubled-cell-detector->Troubled_Cell_Detector) -> Done TODO: Move plot_approximation_results() into plotting script TODO: Improve file naming (e.g. use '.' instead of '__') TODO: Check whether ghost cells are handled/set correctly @@ -55,6 +63,7 @@ TODO: Replace loops with list comprehension if feasible TODO: Replace loops/list comprehension with vectorization if feasible Currently not critical: +TODO: Give option to select plotting color TODO: Add an environment file for Snakemake TODO: Build package (module?) for DG scheme TODO: Investigate g-mesh(?) @@ -66,6 +75,8 @@ TODO: Add a default model state TODO: Look into validators for variable checks Not feasible yet or doc-related: +TODO: Add README for ANN training +TODO: Give detailed description of wavelet detection TODO: Use cfl_number for updating, not just time (equation-related?) TODO: Adjust code to allow classes for all equations (Burger, linear advection, 1D Euler) @@ -74,7 +85,6 @@ TODO: Double-check everything! (also with pylint, pytype, pydoc, pycodestyle, pydocstyle) TODO: Check whether documentation style is correct TODO: Check whether all types in doc are correct -TODO: Discuss adding kwargs to attributes in documentation TODO: Add type annotations to function heads TODO: Clean up docstrings diff --git a/Plotting.py b/Plotting.py index 0c62c0cd231fd4c14f160c26c17f069325a679a7..ff761c5cff62ec73cab3fedba89091c89359c40b 100644 --- a/Plotting.py +++ b/Plotting.py @@ -2,8 +2,6 @@ """ @author: Laura C. Kühle -TODO: Give option to select plotting color - """ import os diff --git a/Troubled_Cell_Detector.py b/Troubled_Cell_Detector.py index 3cb1ce1fdabcd878dbde889ff2c02a176f7d6208..b5978ecb096e51d149dd7b377ca1ddf260e5e0ce 100644 --- a/Troubled_Cell_Detector.py +++ b/Troubled_Cell_Detector.py @@ -12,7 +12,6 @@ TODO: Check if indexing in wavelets is correct -> Done TODO: Combine get_cells() and _get_cells() -> Done TODO: Check coarse_projection calculation for indexing errors -> Done TODO: Adjust Boxplot approach (adjacent cells, outer fence, etc.) -> Done -TODO: Give detailed description of wavelet detection """ from abc import ABC, abstractmethod diff --git a/Update_Scheme.py b/Update_Scheme.py index 33738af56239c144919e3343a598abb8c94965db..2bc72674c89172271a408600ec66340fe7b37152 100644 --- a/Update_Scheme.py +++ b/Update_Scheme.py @@ -2,10 +2,6 @@ """ @author: Laura C. Kühle -TODO: Discuss descriptions (matrices, cfl number, right-hand side, - limiting slope, basis, wavelet, etc.) -TODO: Discuss referencing info on SSPRK3 - """ from abc import ABC, abstractmethod import numpy as np