remove some redundant stuff for delete compare function

Author: robertjwilson

oceanval/__init__.py

@@ -128,26 +128,6 @@ def fix_toc(concise=True, data_dir=None, out_dir=None, info = False):
                 i_chapter += 1
 
 
-#def fix_toc_comparison():
-#    book_dir = "oceanval_comparison"
-#
-#    out = f"{book_dir}/compare/_toc.yml"
-#    # write line by line to out
-#    with open(out, "w") as f:
-#        # "format: jb-book"
-#        x = f.write("format: jb-book\n")
-#        x = f.write("root: intro\n")
-#        x = f.write("parts:\n")
-#        x = f.write(f"- caption: Comparisons with gridded surface observations\n")
-#        x = f.write("  chapters:\n")
-#        x = f.write(f"  - file: notebooks/comparison_bias.ipynb\n")
-#        x = f.write(f"  - file: notebooks/comparison_spatial.ipynb\n")
-#        x = f.write(f"  - file: notebooks/comparison_seasonal.ipynb\n")
-#        x = f.write(f"  - file: notebooks/comparison_regional.ipynb\n")
-#        x = f.write(f"- caption: Comparisons with point observations\n")
-#        x = f.write("  chapters:\n")
-#        x = f.write(f"  - file: notebooks/comparison_point_surface.ipynb\n")
-
 
 def validate(
     lon_lim=None,
@@ -739,347 +719,6 @@ def rebuild(data_dir="."):
     __version__ = "999"
 
 
-#def compare(model_dict=None, view=True, ask = True):
-#    """
-#    Compare pre-validated simulations.
-#    This function will compare the validation output from two simulations.
-#
-#    Parameters
-#    ----------
-#    model_dict : dict
-#        A dictionary of model names and the paths to the validation output. Default is None.
-#        Example: {"model1": "/path/to/model1", "model2": "/path/to/model2"}
-#        If the models have different grids, put the model with the smallest grid first.
-#    view : bool
-#        Default is True. Open the comparison report in a web browser after it is generated.
-#    ask : bool
-#        Default is True. If the oceanval_comparison directory already exists, ask the user if
-#
-#    """
-#
-#    for key in model_dict.keys():
-#        # check that the path exists
-#        if not os.path.exists(model_dict[key]):
-#            raise ValueError(f"Path {model_dict[key]} does not exist")
-#        # convert to an absolute path
-#        model_dict[key] = os.path.abspath(model_dict[key])
-#
-#    if os.path.exists("oceanval_comparison"):
-#        # get user input to decide if it should be removed
-#        if ask:
-#            user_input = input(
-#                "oceanval_comparison directory already exists. This will be emptied and replaced. Do you want to proceed? (y/n): "
-#            )
-#            if user_input.lower() != "y":
-#                print("Exiting")
-#                return None
-#
-#        while True:
-#                files = glob.glob("oceanval_comparison/**/**/**", recursive=True)
-#                # list all files in oceanval_comparison, recursively
-#                for ff in files:
-#                    if ff.startswith("oceanval_comparison"):
-#                        try:
-#                            os.remove(ff)
-#                        except:
-#                            pass
-#                files = glob.glob("oceanval_comparison/**/**/**", recursive=True)
-#                # only list files
-#                files = [x for x in files if os.path.isfile(x)]
-#                if len(files) == 0:
-#                    break
-#        else:
-#            print("Exiting")
-#            return None
-#
-#    if not os.path.exists("oceanval_comparison/compare"):
-#        # create directory recursively
-#        os.makedirs("oceanval_comparison/compare")
-#
-#    # copy the pml logo
-#    shutil.copyfile(
-#        importlib.resources.files(__name__).joinpath("data/pml_logo.jpg"),
-#        "oceanval_comparison/pml_logo.jpg",
-#    )
-#
-#    # move toc etc to oceanval_comparison/compare
-#
-#    data_path = importlib.resources.files(__name__).joinpath("data/_toc.yml")
-#
-#    out = "oceanval_comparison/compare/" + os.path.basename(data_path)
-#    shutil.copyfile(data_path, out)
-#
-#    fix_toc_comparison()
-#
-#    data_path = importlib.resources.files(__name__).joinpath("data/requirements.txt")
-#
-#    out = "oceanval_comparison/compare/" + os.path.basename(data_path)
-#
-#    shutil.copyfile(data_path, out)
-#
-#    data_path = importlib.resources.files(__name__).joinpath("data/intro.md")
-#
-#    out = "oceanval_comparison/compare/" + os.path.basename(data_path)
-#
-#    shutil.copyfile(data_path, out)
-#
-#    # copy config
-#
-#    data_path = importlib.resources.files(__name__).joinpath("data/_config.yml")
-#
-#    out = "oceanval_comparison/compare/" + os.path.basename(data_path)
-#
-#    shutil.copyfile(data_path, out)
-#    # read in out and change some values
-#    with open(out, "r") as file:
-#        filedata = file.read()
-#    # Replace the target string
-#    filedata = filedata.replace("oceanval_report", "../oceanval_comparison")
-#    # Write the file out again
-#    with open(out, "w") as file:
-#        file.write(filedata)
-#
-#    # copy the comparison_seasonal notebook
-#
-#    # make sure the directory exists
-#
-#    if not os.path.exists("oceanval_comparison/compare/notebooks"):
-#        # create directory recursively
-#        os.makedirs("oceanval_comparison/compare/notebooks")
-#
-#    file1 = importlib.resources.files(__name__).joinpath(
-#        "data/comparison_seasonal.ipynb"
-#    )
-#    if (
-#        len(
-#            glob.glob(
-#                "oceanval_comparison/compare/notebooks/*comparison_seasonal.ipynb"
-#            )
-#        )
-#        == 0
-#    ):
-#        shutil.copyfile(
-#            file1, "oceanval_comparison/compare/notebooks/comparison_seasonal.ipynb"
-#        )
-#
-#    model_dict_str = str(model_dict)
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_seasonal.ipynb", "r"
-#    ) as file:
-#        filedata = file.read()
-#
-#    # Replace the target string
-#    filedata = filedata.replace("model_dict_str", model_dict_str)
-#
-#    # Write the file out again
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_seasonal.ipynb", "w"
-#    ) as file:
-#        file.write(filedata)
-#
-#    # now sort out the comparison_spatial notebook
-#
-#    file1 = importlib.resources.files(__name__).joinpath(
-#        "data/comparison_spatial.ipynb"
-#    )
-#    if (
-#        len(
-#            glob.glob("oceanval_comparison/compare/notebooks/*comparison_spatial.ipynb")
-#        )
-#        == 0
-#    ):
-#        shutil.copyfile(
-#            file1, "oceanval_comparison/compare/notebooks/comparison_spatial.ipynb"
-#        )
-#
-#    model_dict_str = str(model_dict)
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_spatial.ipynb", "r"
-#    ) as file:
-#        filedata = file.read()
-#
-#    # Replace the target string
-#    filedata = filedata.replace("model_dict_str", model_dict_str)
-#
-#    # Write the file out again
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_spatial.ipynb", "w"
-#    ) as file:
-#        file.write(filedata)
-#
-#    # move the regional book
-#
-#    file1 = importlib.resources.files(__name__).joinpath(
-#        "data/comparison_regional.ipynb"
-#    )
-#    if (
-#        len(
-#            glob.glob(
-#                "oceanval_comparison/compare/notebooks/*comparison_regional.ipynb"
-#            )
-#        )
-#        == 0
-#    ):
-#        shutil.copyfile(
-#            file1, "oceanval_comparison/compare/notebooks/comparison_regional.ipynb"
-#        )
-#
-#    model_dict_str = str(model_dict)
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_regional.ipynb", "r"
-#    ) as file:
-#        filedata = file.read()
-#
-#    # Replace the target string
-#    filedata = filedata.replace("model_dict_str", model_dict_str)
-#
-#    # Write the file out again
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_regional.ipynb", "w"
-#    ) as file:
-#        file.write(filedata)
-#
-#    # now to comparison_bias
-#
-#    file1 = importlib.resources.files(__name__).joinpath("data/comparison_bias.ipynb")
-#
-#    if (
-#        len(glob.glob("oceanval_comparison/compare/notebooks/*comparison_bias.ipynb"))
-#        == 0
-#    ):
-#        shutil.copyfile(
-#            file1, "oceanval_comparison/compare/notebooks/comparison_bias.ipynb"
-#        )
-#
-#    model_dict_str = str(model_dict)
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_bias.ipynb", "r"
-#    ) as file:
-#        filedata = file.read()
-#
-#    # Replace the target string
-#    filedata = filedata.replace("model_dict_str", model_dict_str)
-#
-#    # Write the file out again
-#
-#    with open(
-#        "oceanval_comparison/compare/notebooks/comparison_bias.ipynb", "w"
-#    ) as file:
-#        file.write(filedata)
-#
-#    # figure out if both simulations have point data
-#
-#    i = 0
-#
-#    if i == 0:
-#        for ss in ["surface"]:
-#            file1 = importlib.resources.files(__name__).joinpath(
-#                "data/comparison_point.ipynb"
-#            )
-#
-#            if (
-#                len(
-#                    glob.glob(
-#                        f"oceanval_comparison/compare/notebooks/*comparison_point_{ss}.ipynb"
-#                    )
-#                )
-#                == 0
-#            ):
-#                shutil.copyfile(
-#                    file1,
-#                    f"oceanval_comparison/compare/notebooks/comparison_point_{ss}.ipynb",
-#                )
-#
-#            model_dict_str = str(model_dict)
-#
-#            with open(
-#                f"oceanval_comparison/compare/notebooks/comparison_point_{ss}.ipynb",
-#                "r",
-#            ) as file:
-#                filedata = file.read()
-#
-#            # Replace the target string
-#            filedata = filedata.replace("model_dict_str", model_dict_str)
-#
-#            # Write the file out again
-#
-#            with open(
-#                f"oceanval_comparison/compare/notebooks/comparison_point_{ss}.ipynb",
-#                "w",
-#            ) as file:
-#                file.write(filedata)
-#            # replace layer in the notebook with ss
-#            with open(
-#                f"oceanval_comparison/compare/notebooks/comparison_point_{ss}.ipynb",
-#                "r",
-#            ) as file:
-#                filedata = file.read()
-#
-#            # Replace the target string
-#            filedata = filedata.replace("layer", ss)
-#
-#            # Write the file out again
-#
-#            with open(
-#                f"oceanval_comparison/compare/notebooks/comparison_point_{ss}.ipynb",
-#                "w",
-#            ) as file:
-#                file.write(filedata)
-#
-#    # sync the notebooks
-#
-#    os.system(
-#        "jupytext --set-formats ipynb,py:percent oceanval_comparison/compare/notebooks/*.ipynb"
-#    )
-#
-#    add_chunks()
-#
-#    # replace the test status in the notebooks
-#    books = glob.glob("oceanval_comparison/compare/notebooks/*.py")
-#    for book in books:
-#        with open(book, "r") as file:
-#            filedata = file.read()
-#
-#        # Replace the target string
-#        filedata = filedata.replace("the_test_status", "False")
-#
-#        # Write the file out again
-#        with open(book, "w") as file:
-#            file.write(filedata)
-#
-#    # fix the chunks
-#    os.system("jupytext --sync oceanval_comparison/compare/notebooks/*.ipynb")
-#
-#    # loop through notebooks and change fast_plot_value to fast_plot
-#
-#    for ff in glob.glob("oceanval_comparison/compare/notebooks/*.ipynb"):
-#        with open(ff, "r") as file:
-#            filedata = file.read()
-#
-#        # Replace the target string
-#        filedata = filedata.replace("fast_plot_value", "False")
-#
-#        # Write the file out again
-#        with open(ff, "w") as file:
-#            file.write(filedata)
-#
-#    os.system("jupyter-book build oceanval_comparison/compare/")
-#    import webbrowser
-#
-#    if view:
-#        webbrowser.open(
-#            "file://"
-#            + os.path.abspath("oceanval_comparison/compare/_build/html/index.html")
-#        )
-#
-
 import tempfile