vswmc-cli 2.0.9__tar.gz → 2.2.0__tar.gz

vswmc_cli-2.2.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: vswmc-cli
+Version: 2.2.0
+Summary: VSWMC Command-Line Tools
+Home-page: https://spaceweather.hpc.kuleuven.be
+Author: Rays of Space
+Author-email: info@raysofspace.com
+License: LGPL
+Platform: Posix; MacOS X; Windows
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: six
+Requires-Dist: requests
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: summary
+
+# VSWMC Command-Line Interface
+
+Install with pip:
+
+    pip install --upgrade vswmc-cli
+
+This will install a `vswmc` command on your system. The `vswmc` command uses an S2P OAuth access token for authentication. Obtain the token outside the CLI, for example with the OAuth 2.0 Client Credentials flow described in the SSO migration guide, then provide it with one of:
+
+`VSWMC_ACCESS_TOKEN`
+
+    Read the access token from the environment.
+
+`--token TOKEN`
+
+    Read the access token from the command line.
+
+`--token-file FILE`
+
+    Read the access token from a file.
+
+Example token request:
+
+    curl \
+      -d 'client_id=<M2M_CLIENT_ID>' \
+      -d 'client_secret=<M2M_CLIENT_SECRET>' \
+      -d 'grant_type=client_credentials' \
+      -d 'scope=<VSWMC_RESOURCE_SERVER_CLIENT_ID>' \
+      'https://sso.s2p.esa.int/realms/swe/protocol/openid-connect/token'
+
+Example CLI usage:
+
+    export VSWMC_ACCESS_TOKEN=<ACCESS_TOKEN>
+    vswmc simulations list
+
+## List available simulations
+    vswmc simulations list
+
+This shows the parameters that a run requires.
+
+
+## Start a run
+    vswmc run [--param-file PARAM_FILE] [--param PARAM=VALUE ...] -- SIMULATION
+
+This command returns the ID of the new run via stdout. You can use this ID to fetch the log or fetch result files.
+
+OPTIONS
+<dl>
+<dt><tt>--param-file PARAM_FILE</tt></dt>
+<dd>Read parameters from a file.</dd>
+<dt><tt>--param PARAM=VALUE ...</tt></dt>
+<dd>Set parameters.</dd>
+</dl>
+
+Each simulation supports different parameters. To know what parameters you need for a particular simulation, run:
+
+    vswmc simulations describe SIMULATION
+
+
+## List runs
+    vswmc ps [--simulation SIMULATION] [-a, --all]
+
+OPTIONS
+<dl>
+<dt><tt>--simulation SIMULATION</tt></dt>
+<dd>Filter on simulation.</dd>
+<dt><tt>-a, --all</tt></dt>
+<dd>List all runs (default shows only ongoing)</dd>
+</dl>
+
+
+## Copy a result file to disk
+    vswmc cp SRC DST
+
+Downloads a remote result file to local disk. The source should be specified in the format <tt>RUN:FILE</tt>. The <tt>DST</tt> argument can be a local file or directory.
+
+
+## Fetch the logs of a run
+    vswmc logs RUN
+
+
+## List the results of a run
+    vswmc ls [-l] RUN
+
+OPTIONS
+<dl>
+<dt><tt>-l</tt></dt>
+<dd>Print long listing</dd>
+</dl>
+
+
+## Save all results of a run
+    vswmc save RUN
+
+Saves all result files of a run. The results of each individual task in this run are compressed and saved into a zip archive named after the model for that task.
+
+
+## Stop one or more runs
+    vswmc stop RUN ...
+
+
+## Remove one or more runs
+    vswmc rm RUN ...
+
+
+## Create a product
+    vswmc products create [--metadata-file FILE] [--metadata PARAM=VALUE ...] [--attach FILE ...] -- PRODUCT_TYPE
+
+OPTIONS
+<dl>
+<dt><tt>--param-file PARAM_FILE</tt></dt>
+<dd>Read parameters from a file.</dd>
+<dt><tt>--param PARAM=VALUE ...</tt></dt>
+<dd>Set parameters.</dd>
+<dt><tt>--attach FILE ...</tt></dt>
+<dd>Attach product files</dd>
+</dl>
+
+EXAMPLE
+
+    vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
+
+Returns the ID of the created product.
+
+
+## Start a run using a product as input
+
+    vswmc run --param corona=6273ce7678eeb43c60d2eb8f \
+              --param grid=test_light \
+              --param cmes=examples/resources/cme_list.dat \
+              -- euhforia-heliosphere-standalone
+
+The `corona` parameter expects a product identifier.

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/README.md

@@ -4,16 +4,33 @@ Install with pip:
 
     pip install --upgrade vswmc-cli
 
-This will install a `vswmc` command on your system. The `vswmc` command has a few global options:
+This will install a `vswmc` command on your system. The `vswmc` command uses an S2P OAuth access token for authentication. Obtain the token outside the CLI, for example with the OAuth 2.0 Client Credentials flow described in the SSO migration guide, then provide it with one of:
 
-`-u USER`
+`VSWMC_ACCESS_TOKEN`
 
-    SSA Username
+    Read the access token from the environment.
 
-`-p PASSWORD`
+`--token TOKEN`
 
-    SSA Password
+    Read the access token from the command line.
 
+`--token-file FILE`
+
+    Read the access token from a file.
+
+Example token request:
+
+    curl \
+      -d 'client_id=<M2M_CLIENT_ID>' \
+      -d 'client_secret=<M2M_CLIENT_SECRET>' \
+      -d 'grant_type=client_credentials' \
+      -d 'scope=<VSWMC_RESOURCE_SERVER_CLIENT_ID>' \
+      'https://sso.s2p.esa.int/realms/swe/protocol/openid-connect/token'
+
+Example CLI usage:
+
+    export VSWMC_ACCESS_TOKEN=<ACCESS_TOKEN>
+    vswmc simulations list
 
 ## List available simulations
     vswmc simulations list
@@ -99,6 +116,7 @@ OPTIONS
 </dl>
 
 EXAMPLE
+
     vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
 
 Returns the ID of the created product.

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/setup.py

@@ -11,13 +11,13 @@ packages = [
 
 setuptools.setup(
     name="vswmc-cli",
-    version="2.0.9",
+    version="2.2.0",
     description="VSWMC Command-Line Tools",
     long_description=readme,
     long_description_content_type="text/markdown",
     url="https://spaceweather.hpc.kuleuven.be",
-    author="Space Applications Services",
-    author_email="info@spaceapplications.com",
+    author="Rays of Space",
+    author_email="info@raysofspace.com",
     license="LGPL",
     packages=packages,
     namespace_packages=["vswmc"],

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/cli/__main__.py

@@ -39,10 +39,11 @@ def main():
         version=dist.version,
         help="Print version information and quit",
     )
+    parser.add_argument("--token", help="S2P OAuth access token")
     parser.add_argument(
-        "-u", metavar="USER", dest="user", required=True, help="SSA Username"
+        "--token-file",
+        help="Read the S2P OAuth access token from a file",
     )
-    parser.add_argument("-p", metavar="PASSWORD", dest="password", help="SSA Password")
     parser.add_argument("--dev", action="store_true", help=argparse.SUPPRESS)
     parser.add_argument("--debug", action="store_true", help=argparse.SUPPRESS)
     parser.add_argument(

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/cli/cp.py

@@ -23,9 +23,22 @@ def do_cp(args):
         f.write(content)
 
 
+def do_cp_new(args):
+    client = utils.create_client(args)
+    run, src_file = args.src.split(":")
+    content = client.get_run_output_presign_content(run, src_file)
+    _, src_filename = os.path.split(src_file)
+
+    if os.path.isdir(args.dst):
+        target_file = os.path.join(args.dst, src_filename)
+    else:
+        target_file = args.dst
+
+    with open(target_file, "wb") as f:
+        f.write(content)
+
+
 def configure_parser(parser):
-    parser.set_defaults(func=do_cp)
-    parser.add_argument(
-        "src", metavar="SRC", type=str, help="file in the format RUN:FILE"
-    )
+    parser.set_defaults(func=do_cp_new)
+    parser.add_argument("src", metavar="SRC", type=str, help="file in the format RUN:FILE")
     parser.add_argument("dst", metavar="DST", type=str, help="target file or directory")

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/cli/logs.py

@@ -17,7 +17,7 @@ def do_logs(args):
         print(content.strip())
 
     if args.follow:
-        subscription = client.follow_logs(args.user, args.run, on_data=on_data)
+        subscription = client.follow_logs(args.run, on_data=on_data)
         subscription.result()
 
 

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/cli/ls.py

@@ -21,7 +21,24 @@ def do_ls(args):
     utils.print_table(rows)
 
 
+def do_ls_new(args):
+    client = utils.create_client(args)
+    outputs = client.list_run_outputs(args.run)
+    rows = []
+    for result in outputs:
+        if args.l:
+            rows.append(
+                [
+                    str(result["size"]),
+                    result["path"],
+                ]
+            )
+        else:
+            rows.append([result["path"]])
+    utils.print_table(rows)
+
+
 def configure_parser(parser):
-    parser.set_defaults(func=do_ls)
+    parser.set_defaults(func=do_ls_new)
     parser.add_argument("run", metavar="RUN", help="The run to query")
     parser.add_argument("-l", action="store_true", help="Print long listing")

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/cli/run.py

@@ -53,7 +53,7 @@ def do_run(args):
         content = client.download_logs(run["id"]).strip()
         if content:
             print(content)
-        subscription = client.follow_logs(args.user, run["id"], on_data=on_data)
+        subscription = client.follow_logs(run["id"], on_data=on_data)
         subscription.result()
     else:
         print(run["id"])

vswmc_cli-2.2.0/vswmc/cli/save.py

@@ -0,0 +1,35 @@
+from __future__ import print_function
+
+import os
+
+from vswmc.cli import utils
+
+
+def do_save(args):
+    client = utils.create_client(args)
+    content = client.download_results(args.run)
+
+    target_file = args.run + ".zip"
+    print("Saving {}".format(target_file))
+    with open(target_file, "wb") as f:
+        f.write(content)
+
+
+def do_save_new(args):
+    client = utils.create_client(args)
+    outputs = client.list_run_outputs(args.run)
+    if not outputs:
+        print("No outputs available for run {}".format(args.run))
+        return
+    os.path.makedirs(args.run, exist_ok=True)
+    for output in outputs:
+        content = client.get_run_output_presign_content(args.run, output["path"])
+        target_file = os.path.join(args.run, output["path"])
+        print("Saving {}".format(target_file))
+        with open(target_file, "wb") as f:
+            f.write(content)
+
+
+def configure_parser(parser):
+    parser.set_defaults(func=do_save_new)
+    parser.add_argument("run", metavar="RUN", help="The run to save")

vswmc_cli-2.2.0/vswmc/cli/utils.py

@@ -0,0 +1,60 @@
+from __future__ import print_function
+
+import os
+
+from vswmc.client import VswmcClient
+from vswmc.core import auth
+
+
+def create_client(args):
+    # Bypass auth for local development
+    if args.dev:
+        return VswmcClient("http://localhost:3000")
+
+    token = resolve_token(args)
+    if not token:
+        raise Exception(
+            "Missing access token. Provide --token, --token-file, or VSWMC_ACCESS_TOKEN."
+        )
+
+    credentials = auth.TokenCredentials(token=token)
+    return VswmcClient(args.url, credentials=credentials)
+
+
+def resolve_token(args):
+    if args.token:
+        return args.token.strip()
+
+    if args.token_file:
+        with open(os.path.expanduser(args.token_file), "r") as f:
+            return f.read().strip()
+
+    token = os.environ.get("VSWMC_ACCESS_TOKEN")
+    return token.strip() if token else None
+
+
+def print_table(rows, header=False):
+    widths = list(map(len, rows[0]))
+    for row in rows:
+        for idx, col in enumerate(row):
+            widths[idx] = max(len(str(col)), widths[idx])
+
+    separator = "  "
+
+    total_width = 0
+    for width in widths:
+        total_width += width
+    total_width += len(separator) * (len(widths) - 1)
+
+    data = rows[1:] if header else rows
+    if header and data:
+        cols = separator.join(
+            [str.ljust(str(col), width) for col, width in zip(rows[0], widths)]
+        )
+        print(cols)
+    if data:
+        for row in data:
+            cols = separator.join(
+                [str.ljust(str(col), width) for col, width in zip(row, widths)]
+            )
+            print(cols)

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc/client.py

@@ -5,8 +5,6 @@ import requests
 from vswmc.core.exceptions import NotFound, Unauthorized, VswmcError
 from vswmc.sockjs import SockJSSession
 
-SSO_URL = "https://sso.ssa.esa.int/am/json/authenticate"
-
 
 class VswmcClient(object):
     def __init__(self, address, credentials=None):
@@ -17,37 +15,30 @@ class VswmcClient(object):
 
         self.session = requests.Session()
         if credentials:
-            self.login(credentials)
+            self.authenticate(credentials)
 
-    def login(self, credentials):
-        self.session.cookies.clear()
+    def authenticate(self, credentials):
+        token = credentials.token.strip() if credentials.token else None
+        if not token:
+            raise Unauthorized("Missing access token")
 
-        res = self.session.post(
-            SSO_URL,
-            headers={
-                "X-OpenAM-Username": credentials.username,
-                "X-OpenAM-Password": credentials.password,
-            },
+        self.session.cookies.clear()
+        authorization = (
+            token if token.lower().startswith("bearer ") else "Bearer " + token
         )
+        self.session.headers.update({"Authorization": authorization})
 
-        msg = res.json()
-        if "tokenId" not in msg:
-            code = msg["code"]
-            reason = msg["reason"]
-            message = msg["message"]
-            if code == 401:
-                raise Unauthorized("Authentication Failed")
-            else:
-                raise VswmcError(reason + ": " + message)
-
-        token = msg["tokenId"]
-        self.session.cookies.set("iPlanetDirectoryPro", token)
-        self.session.cookies.set("esa-ssa-sso-cookie", token)
+    def login(self, credentials):
+        self.authenticate(credentials)
 
     def list_models(self):
         path = "{}/models".format(self.api_root)
         return self._request("get", path=path).json()["models"]
 
+    def get_current_user(self):
+        path = "{}/user".format(self.api_root)
+        return self._request("get", path=path).json()
+
     def get_model(self, name):
         path = "{}/models/{}".format(self.api_root, name)
         return self._request("get", path=path).json()
@@ -106,6 +97,22 @@ class VswmcClient(object):
         path = "{}/runs/{}".format(self.api_root, run)
         return self._request("get", path=path).json()
 
+    def list_run_outputs(self, run):
+        path = "{}/runs/{}/outputs".format(self.api_root, run)
+        return self._request("get", path=path).json()
+
+    def get_run_output(self, run, name):
+        path = "{}/runs/{}/outputs/{}".format(self.api_root, run, name)
+        return self._request("get", path=path).content
+    
+    def get_run_output_presign_url(self, run, name):
+        path = "{}/runs/{}/outputs/{}/presign".format(self.api_root, run, name)
+        return self._request("get", path=path).json()
+    
+    def get_run_output_presign_content(self, run, name):
+        presign = self.get_run_output_presign_url(run, name)
+        return requests.get(url=presign["url"]).content
+
     def download_logs(self, run):
         path = "{}/runs/{}/log".format(self.api_root, run)
         return self._request("get", path=path, params={"raw": "yes"}).content
@@ -118,11 +125,12 @@ class VswmcClient(object):
         path = "{}/runs/{}/results".format(self.api_root, run)
         return self._request("get", path=path).content
 
-    def follow_logs(self, user, run, on_data):
+    def follow_logs(self, run, on_data):
         def filter_(msg, sess):
             if run == msg["headers"]["runId"]:
                 on_data(msg["body"], sess)
 
+        user = self.get_current_user()["subject"]
         session = SockJSSession(self.address, on_data=filter_, session=self.session)
         session.send(
             json.dumps(
@@ -147,24 +155,14 @@ class VswmcClient(object):
         return "localhost" in self.address or "spaceweather2" in self.address
 
     def upload_magnetogram(self, f, name):
-        if self.is_test():
-            upload = self.upload_file(f, name)
-            path = "{}/products/magnetograms/USER/{}".format(self.api_root, upload)
-            return self._request("get", path=path).json()
-        else:
-            path = "{}/products/magnetograms".format(self.api_root)
-            files = {"file": (name, f, "application/octet-stream")}
-            return self._request("post", path=path, files=files).json()
+        upload = self.upload_file(f, name)
+        path = "{}/products/magnetograms/USER/{}".format(self.api_root, upload)
+        return self._request("get", path=path).json()
 
     def upload_cme_file(self, f, name):
-        if self.is_test():
-            upload = self.upload_file(f, name)
-            path = "{}/products/cme/{}".format(self.api_root, upload)
-            return self._request("get", path=path).json()
-        else:
-            path = "{}/products/cme".format(self.api_root)
-            files = {"file": (name, f, "application/octet-stream")}
-            return self._request("post", path=path, files=files).json()
+        upload = self.upload_file(f, name)
+        path = "{}/products/cme/{}".format(self.api_root, upload)
+        return self._request("get", path=path).json()
 
     def upload_file(self, f, name):
         path = "{}/uploads".format(self.api_root)
@@ -175,8 +173,7 @@ class VswmcClient(object):
         response = self.session.request(method, path, **kwargs)
 
         if response.headers.get("content-type", "").startswith("text/html"):
-            if "OpenAM" in response.text:
-                raise Unauthorized("Invalid session")
+            raise Unauthorized("Invalid or expired access token")
 
         if 200 <= response.status_code < 300:
             return response

vswmc_cli-2.2.0/vswmc/core/auth.py

@@ -0,0 +1,3 @@
+class TokenCredentials(object):
+    def __init__(self, token=None):
+        self.token = token

vswmc_cli-2.2.0/vswmc_cli.egg-info/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: vswmc-cli
+Version: 2.2.0
+Summary: VSWMC Command-Line Tools
+Home-page: https://spaceweather.hpc.kuleuven.be
+Author: Rays of Space
+Author-email: info@raysofspace.com
+License: LGPL
+Platform: Posix; MacOS X; Windows
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: six
+Requires-Dist: requests
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: summary
+
+# VSWMC Command-Line Interface
+
+Install with pip:
+
+    pip install --upgrade vswmc-cli
+
+This will install a `vswmc` command on your system. The `vswmc` command uses an S2P OAuth access token for authentication. Obtain the token outside the CLI, for example with the OAuth 2.0 Client Credentials flow described in the SSO migration guide, then provide it with one of:
+
+`VSWMC_ACCESS_TOKEN`
+
+    Read the access token from the environment.
+
+`--token TOKEN`
+
+    Read the access token from the command line.
+
+`--token-file FILE`
+
+    Read the access token from a file.
+
+Example token request:
+
+    curl \
+      -d 'client_id=<M2M_CLIENT_ID>' \
+      -d 'client_secret=<M2M_CLIENT_SECRET>' \
+      -d 'grant_type=client_credentials' \
+      -d 'scope=<VSWMC_RESOURCE_SERVER_CLIENT_ID>' \
+      'https://sso.s2p.esa.int/realms/swe/protocol/openid-connect/token'
+
+Example CLI usage:
+
+    export VSWMC_ACCESS_TOKEN=<ACCESS_TOKEN>
+    vswmc simulations list
+
+## List available simulations
+    vswmc simulations list
+
+This shows the parameters that a run requires.
+
+
+## Start a run
+    vswmc run [--param-file PARAM_FILE] [--param PARAM=VALUE ...] -- SIMULATION
+
+This command returns the ID of the new run via stdout. You can use this ID to fetch the log or fetch result files.
+
+OPTIONS
+<dl>
+<dt><tt>--param-file PARAM_FILE</tt></dt>
+<dd>Read parameters from a file.</dd>
+<dt><tt>--param PARAM=VALUE ...</tt></dt>
+<dd>Set parameters.</dd>
+</dl>
+
+Each simulation supports different parameters. To know what parameters you need for a particular simulation, run:
+
+    vswmc simulations describe SIMULATION
+
+
+## List runs
+    vswmc ps [--simulation SIMULATION] [-a, --all]
+
+OPTIONS
+<dl>
+<dt><tt>--simulation SIMULATION</tt></dt>
+<dd>Filter on simulation.</dd>
+<dt><tt>-a, --all</tt></dt>
+<dd>List all runs (default shows only ongoing)</dd>
+</dl>
+
+
+## Copy a result file to disk
+    vswmc cp SRC DST
+
+Downloads a remote result file to local disk. The source should be specified in the format <tt>RUN:FILE</tt>. The <tt>DST</tt> argument can be a local file or directory.
+
+
+## Fetch the logs of a run
+    vswmc logs RUN
+
+
+## List the results of a run
+    vswmc ls [-l] RUN
+
+OPTIONS
+<dl>
+<dt><tt>-l</tt></dt>
+<dd>Print long listing</dd>
+</dl>
+
+
+## Save all results of a run
+    vswmc save RUN
+
+Saves all result files of a run. The results of each individual task in this run are compressed and saved into a zip archive named after the model for that task.
+
+
+## Stop one or more runs
+    vswmc stop RUN ...
+
+
+## Remove one or more runs
+    vswmc rm RUN ...
+
+
+## Create a product
+    vswmc products create [--metadata-file FILE] [--metadata PARAM=VALUE ...] [--attach FILE ...] -- PRODUCT_TYPE
+
+OPTIONS
+<dl>
+<dt><tt>--param-file PARAM_FILE</tt></dt>
+<dd>Read parameters from a file.</dd>
+<dt><tt>--param PARAM=VALUE ...</tt></dt>
+<dd>Set parameters.</dd>
+<dt><tt>--attach FILE ...</tt></dt>
+<dd>Attach product files</dd>
+</dl>
+
+EXAMPLE
+
+    vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
+
+Returns the ID of the created product.
+
+
+## Start a run using a product as input
+
+    vswmc run --param corona=6273ce7678eeb43c60d2eb8f \
+              --param grid=test_light \
+              --param cmes=examples/resources/cme_list.dat \
+              -- euhforia-heliosphere-standalone
+
+The `corona` parameter expects a product identifier.

{vswmc-cli-2.0.9 → vswmc_cli-2.2.0}/vswmc_cli.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 vswmc = vswmc.cli.__main__:main
-

vswmc-cli-2.0.9/PKG-INFO

@@ -1,140 +0,0 @@
-Metadata-Version: 2.1
-Name: vswmc-cli
-Version: 2.0.9
-Summary: VSWMC Command-Line Tools
-Home-page: https://spaceweather.hpc.kuleuven.be
-Author: Space Applications Services
-Author-email: info@spaceapplications.com
-License: LGPL
-Description: # VSWMC Command-Line Interface
-        
-        Install with pip:
-        
-            pip install --upgrade vswmc-cli
-        
-        This will install a `vswmc` command on your system. The `vswmc` command has a few global options:
-        
-        `-u USER`
-        
-            SSA Username
-        
-        `-p PASSWORD`
-        
-            SSA Password
-        
-        
-        ## List available simulations
-            vswmc simulations list
-        
-        This shows the parameters that a run requires.
-        
-        
-        ## Start a run
-            vswmc run [--param-file PARAM_FILE] [--param PARAM=VALUE ...] -- SIMULATION
-        
-        This command returns the ID of the new run via stdout. You can use this ID to fetch the log or fetch result files.
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--param-file PARAM_FILE</tt></dt>
-        <dd>Read parameters from a file.</dd>
-        <dt><tt>--param PARAM=VALUE ...</tt></dt>
-        <dd>Set parameters.</dd>
-        </dl>
-        
-        Each simulation supports different parameters. To know what parameters you need for a particular simulation, run:
-        
-            vswmc simulations describe SIMULATION
-        
-        
-        ## List runs
-            vswmc ps [--simulation SIMULATION] [-a, --all]
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--simulation SIMULATION</tt></dt>
-        <dd>Filter on simulation.</dd>
-        <dt><tt>-a, --all</tt></dt>
-        <dd>List all runs (default shows only ongoing)</dd>
-        </dl>
-        
-        
-        ## Copy a result file to disk
-            vswmc cp SRC DST
-        
-        Downloads a remote result file to local disk. The source should be specified in the format <tt>RUN:FILE</tt>. The <tt>DST</tt> argument can be a local file or directory.
-        
-        
-        ## Fetch the logs of a run
-            vswmc logs RUN
-        
-        
-        ## List the results of a run
-            vswmc ls [-l] RUN
-        
-        OPTIONS
-        <dl>
-        <dt><tt>-l</tt></dt>
-        <dd>Print long listing</dd>
-        </dl>
-        
-        
-        ## Save all results of a run
-            vswmc save RUN
-        
-        Saves all result files of a run. The results of each individual task in this run are compressed and saved into a zip archive named after the model for that task.
-        
-        
-        ## Stop one or more runs
-            vswmc stop RUN ...
-        
-        
-        ## Remove one or more runs
-            vswmc rm RUN ...
-        
-        
-        ## Create a product
-            vswmc products create [--metadata-file FILE] [--metadata PARAM=VALUE ...] [--attach FILE ...] -- PRODUCT_TYPE
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--param-file PARAM_FILE</tt></dt>
-        <dd>Read parameters from a file.</dd>
-        <dt><tt>--param PARAM=VALUE ...</tt></dt>
-        <dd>Set parameters.</dd>
-        <dt><tt>--attach FILE ...</tt></dt>
-        <dd>Attach product files</dd>
-        </dl>
-        
-        EXAMPLE
-            vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
-        
-        Returns the ID of the created product.
-        
-        
-        ## Start a run using a product as input
-        
-            vswmc run --param corona=6273ce7678eeb43c60d2eb8f \
-                      --param grid=test_light \
-                      --param cmes=examples/resources/cme_list.dat \
-                      -- euhforia-heliosphere-standalone
-        
-        The `corona` parameter expects a product identifier.
-        
-Platform: Posix; MacOS X; Windows
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown

vswmc-cli-2.0.9/vswmc/cli/save.py

@@ -1,18 +0,0 @@
-from __future__ import print_function
-
-from vswmc.cli import utils
-
-
-def do_save(args):
-    client = utils.create_client(args)
-    content = client.download_results(args.run)
-
-    target_file = args.run + ".zip"
-    print("Saving {}".format(target_file))
-    with open(target_file, "wb") as f:
-        f.write(content)
-
-
-def configure_parser(parser):
-    parser.set_defaults(func=do_save)
-    parser.add_argument("run", metavar="RUN", help="The run to save")

vswmc-cli-2.0.9/vswmc/cli/utils.py

@@ -1,85 +0,0 @@
-from __future__ import print_function
-
-import os
-import pickle
-from getpass import getpass
-
-from vswmc.client import VswmcClient
-from vswmc.core import auth
-
-HOME = os.path.expanduser("~")
-CONFIG_DIR = os.path.join(os.path.join(HOME, ".config"), "vswmc-cli")
-CREDENTIALS_FILE = os.path.join(CONFIG_DIR, "credentials")
-
-
-def create_client(args):
-    # Bypass auth for local development
-    if args.dev:
-        return VswmcClient("http://localhost:3000")
-
-    client = VswmcClient(args.url)
-
-    logged_in = False
-    if os.path.exists(CREDENTIALS_FILE):
-        with open(CREDENTIALS_FILE, "rb") as f:
-            creds = pickle.load(f)
-            if creds["username"] == args.user:
-                client.session.cookies.update(creds["cookies"])
-                # Quick check to test if this session is still functional
-                try:
-                    client.list_models()
-                    logged_in = True
-                except:
-                    pass
-    if not logged_in:
-        password = args.password or getpass("Password: ")
-        if not password:
-            print("*** Password may not be null")
-            return False
-
-        credentials = auth.Credentials(username=args.user, password=password)
-        client.login(credentials)
-        save_session(args.user, client.session.cookies)
-
-    return client
-
-
-def save_session(username, cookies):
-    if not os.path.exists(CONFIG_DIR):
-        os.makedirs(CONFIG_DIR)
-
-    with open(CREDENTIALS_FILE, "wb") as f:
-        pickle.dump(
-            {
-                "username": username,
-                "cookies": cookies,
-            },
-            f,
-        )
-
-
-def print_table(rows, header=False):
-    widths = list(map(len, rows[0]))
-    for row in rows:
-        for idx, col in enumerate(row):
-            widths[idx] = max(len(str(col)), widths[idx])
-
-    separator = "  "
-
-    total_width = 0
-    for width in widths:
-        total_width += width
-    total_width += len(separator) * (len(widths) - 1)
-
-    data = rows[1:] if header else rows
-    if header and data:
-        cols = separator.join(
-            [str.ljust(str(col), width) for col, width in zip(rows[0], widths)]
-        )
-        print(cols)
-    if data:
-        for row in data:
-            cols = separator.join(
-                [str.ljust(str(col), width) for col, width in zip(row, widths)]
-            )
-            print(cols)

vswmc-cli-2.0.9/vswmc/core/auth.py

@@ -1,4 +0,0 @@
-class Credentials(object):
-    def __init__(self, username=None, password=None):
-        self.username = username
-        self.password = password

vswmc-cli-2.0.9/vswmc_cli.egg-info/PKG-INFO

@@ -1,140 +0,0 @@
-Metadata-Version: 2.1
-Name: vswmc-cli
-Version: 2.0.9
-Summary: VSWMC Command-Line Tools
-Home-page: https://spaceweather.hpc.kuleuven.be
-Author: Space Applications Services
-Author-email: info@spaceapplications.com
-License: LGPL
-Description: # VSWMC Command-Line Interface
-        
-        Install with pip:
-        
-            pip install --upgrade vswmc-cli
-        
-        This will install a `vswmc` command on your system. The `vswmc` command has a few global options:
-        
-        `-u USER`
-        
-            SSA Username
-        
-        `-p PASSWORD`
-        
-            SSA Password
-        
-        
-        ## List available simulations
-            vswmc simulations list
-        
-        This shows the parameters that a run requires.
-        
-        
-        ## Start a run
-            vswmc run [--param-file PARAM_FILE] [--param PARAM=VALUE ...] -- SIMULATION
-        
-        This command returns the ID of the new run via stdout. You can use this ID to fetch the log or fetch result files.
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--param-file PARAM_FILE</tt></dt>
-        <dd>Read parameters from a file.</dd>
-        <dt><tt>--param PARAM=VALUE ...</tt></dt>
-        <dd>Set parameters.</dd>
-        </dl>
-        
-        Each simulation supports different parameters. To know what parameters you need for a particular simulation, run:
-        
-            vswmc simulations describe SIMULATION
-        
-        
-        ## List runs
-            vswmc ps [--simulation SIMULATION] [-a, --all]
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--simulation SIMULATION</tt></dt>
-        <dd>Filter on simulation.</dd>
-        <dt><tt>-a, --all</tt></dt>
-        <dd>List all runs (default shows only ongoing)</dd>
-        </dl>
-        
-        
-        ## Copy a result file to disk
-            vswmc cp SRC DST
-        
-        Downloads a remote result file to local disk. The source should be specified in the format <tt>RUN:FILE</tt>. The <tt>DST</tt> argument can be a local file or directory.
-        
-        
-        ## Fetch the logs of a run
-            vswmc logs RUN
-        
-        
-        ## List the results of a run
-            vswmc ls [-l] RUN
-        
-        OPTIONS
-        <dl>
-        <dt><tt>-l</tt></dt>
-        <dd>Print long listing</dd>
-        </dl>
-        
-        
-        ## Save all results of a run
-            vswmc save RUN
-        
-        Saves all result files of a run. The results of each individual task in this run are compressed and saved into a zip archive named after the model for that task.
-        
-        
-        ## Stop one or more runs
-            vswmc stop RUN ...
-        
-        
-        ## Remove one or more runs
-            vswmc rm RUN ...
-        
-        
-        ## Create a product
-            vswmc products create [--metadata-file FILE] [--metadata PARAM=VALUE ...] [--attach FILE ...] -- PRODUCT_TYPE
-        
-        OPTIONS
-        <dl>
-        <dt><tt>--param-file PARAM_FILE</tt></dt>
-        <dd>Read parameters from a file.</dd>
-        <dt><tt>--param PARAM=VALUE ...</tt></dt>
-        <dd>Set parameters.</dd>
-        <dt><tt>--attach FILE ...</tt></dt>
-        <dd>Attach product files</dd>
-        </dl>
-        
-        EXAMPLE
-            vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
-        
-        Returns the ID of the created product.
-        
-        
-        ## Start a run using a product as input
-        
-            vswmc run --param corona=6273ce7678eeb43c60d2eb8f \
-                      --param grid=test_light \
-                      --param cmes=examples/resources/cme_list.dat \
-                      -- euhforia-heliosphere-standalone
-        
-        The `corona` parameter expects a product identifier.
-        
-Platform: Posix; MacOS X; Windows
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown