muse2 2.1.0

A tool for running simulations of energy systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

#!/usr/bin/env python3
#
# A script to generate documentation for previous releases of MUSE2.

import os
import shutil
import subprocess as sp
from pathlib import Path
from tempfile import TemporaryDirectory

from release import get_releases

DOCS_SITE_ROOT = "https://energysystemsmodellinglab.github.io/MUSE2"
REPO_ROOT = Path(__file__).parent.parent.absolute()
DOCS_DIR = REPO_ROOT / "docs"


def clone_repo_to(dest: Path):
    """Clone this repo somewhere else."""
    print("Making a copy of repo")
    sp.run(("git", "clone", REPO_ROOT, dest), check=True, capture_output=True)

    # Add a symlink to cargo cache dir
    try:
        os.symlink(REPO_ROOT / "target", dest / "target")
    except (NotImplementedError, OSError):
        # Only newer versions of Windows support symlinks and these require the user to have
        # additional privileges (or to be in developer mode)
        print(
            "WARN: Could not create symlink to cache directory; cache will not be stored"
        )


def apply_patches_for_release(release: str, repo_path: Path) -> None:
    """Apply patches (if any) for the given release."""
    patches_dir = DOCS_DIR / "release" / "patches" / release
    for patch_path in sorted(patches_dir.glob("*.patch")):
        sp.run(("git", "-C", str(repo_path), "am", str(patch_path)), check=True)


def build_docs_for_release(release: str, repo_path: Path, outdir: Path) -> None:
    """Build documentation for a given release."""
    print(f"Building docs for {release}")

    # Check out release
    sp.run(
        ("git", "-C", str(repo_path), "checkout", release),
        check=True,
        capture_output=True,
    )

    # Apply patches, if any
    apply_patches_for_release(release, repo_path)

    # Build docs
    sp.run(("just", f"{repo_path!s}/build-docs"), check=True)

    # Patch versions.html to redirect to main versions page
    with (repo_path / "book" / "versions.html").open("w", encoding="utf-8") as f:
        f.write(f"""<head>
    <meta http-equiv="Refresh" content="0; URL={DOCS_SITE_ROOT}/versions.html" />
</head>""")

    # Move to output directory
    release_outdir = outdir / release
    print(f"Copying to {release_outdir}")
    shutil.move((repo_path / "book"), release_outdir)


def build_old_docs() -> None:
    """Build documentation for previous releases."""
    outdir = REPO_ROOT / "book" / "release"
    outdir.mkdir(parents=True, exist_ok=True)

    # Clone this repo to a temporary directory
    with TemporaryDirectory() as tmpdir:
        repo_path = Path(tmpdir)
        clone_repo_to(repo_path)

        # Generate documentation for each previous release
        for release in get_releases():
            build_docs_for_release(release, repo_path, outdir)


if __name__ == "__main__":
    build_old_docs()