partis-basis 0.0.4__py3-none-any.whl

partis_basis-0.0.4.data/purelib/partis/basis/__main__.py

@@ -0,0 +1,331 @@
+from __future__ import annotations
+import sys
+import os
+from pathlib import Path
+import re
+import shutil
+import json
+import argparse
+import shlex
+from subprocess import check_output, check_call
+
+_PY = f"{'.'.join(str(v) for v in sys.version_info[:2])}"
+APPS = ['bash', 'fish', 'manage']
+
+PASS_ENV = frozenset([
+  'USER',
+  'LOGNAME',
+  'LANG',
+  'LANGUAGE',
+  'LC_CTYPE',
+  'TERM',
+  'COLORFGBG',
+  'COLORTERM',
+  'LSCOLORS',
+  'LS_COLORS',
+  'DISPLAY',
+  'NO_COLOR',
+  'PY_COLORS',
+  'CLICOLOR',
+  'CLICOLOR_FORCE',
+  'FORCE_COLOR',
+  'NOHM_MIN_LOG_LEVEL',
+  'BASIS_DEBUG',
+  'XLA_PYTHON_CLIENT_ALLOCATOR',
+  'XLA_PYTHON_CLIENT_PREALLOCATE',
+  'TF_CPP_MIN_LOG_LEVEL',
+  'TF_CPP_MAX_VLOG_LEVEL',
+  'TF_CPP_VMODULE',
+  'PJRT_NPROC',
+  'XLA_FLAGS'])
+
+MPI_ENV_REC = re.compile('|'.join([
+  # OpenMPI:
+  '(OMPI_*\w+)',
+  '(PMIX_*\w+)',
+  '(OPAL_*\w+)',
+  '(ORTE_*\w+)',
+
+  # MPICH:
+  '(MPIR_*\w+)',
+  '(PMI_*\w+)',
+  '(PMIX_*\w+)',
+  '(HYDRA_*\w+)',
+
+  # Intel MPI:
+  '(I_MPI_*\w+)',
+  '(MPIR_*\w+)',
+  '(PMI_*\w+)',
+  '(PMIX_*\w+)',
+  '(HYDRA_*\w+)',
+
+  # MVAPICH2:
+  '(MV2_*\w+)',
+  '(MPIR_*\w+)',
+  '(PMI_*\w+)',
+  '(PMIX_*\w+)',
+  '(HYDRA_*\w+)']))
+
+DEFAULT_IMAGE = "library://kcdodd/basis/ubuntu-22.04-basis:0.0.4"
+
+
+#===============================================================================
+def _basis(*,
+    image: str|None = None,
+    basis: Path|None = None,
+    create: bool = True) -> tuple[str, Path, Path]:
+
+  if basis is None:
+    venv: str|Path = os.environ.get('VIRTUAL_ENV', '')
+
+    if venv:
+      venv = Path(venv).resolve()
+
+    if not (venv and venv.exists()):
+      raise FileNotFoundError(f"No active virtual environment: {venv}")
+
+    basis = venv/'.basis'
+
+  default = basis/'mods'/'environment'/'.version'
+  created = False
+
+  if create and not basis.exists():
+    basis.mkdir(parents=True)
+    created = True
+
+  basis_config_file = basis/'.config'/'basis'
+
+  if basis_config_file.exists():
+    basis_config = json.loads(basis_config_file.read_text())
+    _image = basis_config['image']
+
+    if image is None:
+      # image originally used to create basis directory
+      image = _image
+
+    elif image != _image:
+      print("Warning: Basis directory originally created using different image, behavior may be undefined.")
+      print(f" original imag: {_image!r}")
+
+  else:
+    basis_config_file.parent.mkdir(exist_ok=True, parents=True)
+
+    if created:
+      if image is None:
+        image = DEFAULT_IMAGE
+
+      basis_config_file.write_text(json.dumps({
+        'image': str(image)}))
+
+    else:
+      # fixup environment created without config file
+      # NOTE: hardcoded assumption that all older versions created with this image
+      basis_config_file.write_text(json.dumps({
+        'image': "library://kcdodd/basis/ubuntu-22.04-basis:0.0.2"}))
+
+  assert isinstance(image, str)
+
+  return image, basis, default
+
+#===============================================================================
+def init(image, basis, cwd, python):
+  name = 'init'
+
+  singularity = shutil.which('singularity')
+
+  if not singularity:
+    print("Error: Program 'singularity' not found")
+    return 1
+
+  image, basis, default = _basis(basis=basis, image=image)
+  env_dir = basis/'envs'/name
+
+  if env_dir.is_dir() and any(env_dir.iterdir()):
+    print(f"Cannot initialize non-empty directory: {env_dir}")
+    return 1
+
+  pwd = str(cwd)
+  env = {
+    k:v
+    for k,v in os.environ.items()
+    if k in PASS_ENV or MPI_ENV_REC.fullmatch(k)}
+
+  def _run(*cmd):
+    check_call([
+      singularity,
+      'run',
+      '--app', 'manage',
+      '--no-home',
+      '--pwd', str(pwd),
+      '--bind', f"{basis}:/basis",
+      str(image),
+      *cmd],
+      env=env)
+
+  _run('create', name, str(python))
+
+  default.write_text(f'#%Module\nset ModulesVersion {name}')
+
+  return 0
+
+#===============================================================================
+def run(image, basis, app, work, cwd, cmd):
+  singularity = shutil.which('singularity')
+  nvccli = shutil.which('nvidia-container-cli')
+
+  if not singularity:
+    print("Error: Program 'singularity' not found")
+    return 1
+
+  if nvccli:
+    runhelp = check_output([singularity, 'run', '--help']).decode('utf-8')
+
+    if '--nvccli' not in runhelp:
+      print("Warning: singularity version must be >= 3.9 to utilize nvidia-container-toolkit found on host")
+      nvccli = None
+
+  work = work.resolve()
+
+  image, basis, default = _basis(basis=basis, image=image)
+
+  env = {
+    k:v
+    for k,v in os.environ.items()
+    if k in PASS_ENV or MPI_ENV_REC.fullmatch(k)}
+
+  pwd = str(cwd)
+
+  extra_args = []
+
+  if nvccli:
+    extra_args.extend(['--nv', '--nvccli'])
+
+  cmd_singularity = [
+    singularity,
+    'run',
+    '--app',
+    app,
+    *extra_args,
+    '--no-home',
+    '--pwd', str(pwd),
+    '--bind', f"{basis}:/basis",
+    '--bind', f"{work}:/work",
+    '--bind', f"{pwd}:{pwd}",
+    str(image),
+    *cmd]
+
+  print(f"image: {image}")
+  print(f"  app: {app}")
+  print(f"basis: {basis}")
+  print(f" work: {work}")
+  print(f"  cwd: {cwd}")
+  print(f" exec: {shlex.join(cmd)}")
+  print("Entering container...")
+
+  # flush stdout before replacing process
+  sys.stdout.flush()
+  sys.stderr.flush()
+  os.execve(cmd_singularity[0], cmd_singularity, env)
+
+#===============================================================================
+def _cuda_info(nvccli):
+  info = check_output([nvccli, 'info', '--csv']).decode('utf-8')
+  lines = info.splitlines()
+  nvrm_version, cuda_version = lines[1].split(',')
+
+  nvrm_version = tuple(int(v) for v in nvrm_version.split('.'))
+  cuda_version = tuple(int(v) for v in cuda_version.split('.'))
+
+  return nvrm_version, cuda_version
+
+#===============================================================================
+def main():
+
+  parser = argparse.ArgumentParser(
+      description="partis-basis runner for singularity container based environments")
+
+  parser.add_argument(
+      '-i', '--image',
+      help="",
+      type=str,
+      default=None)
+
+  parser.add_argument(
+      '-a', '--app',
+      help=f"{', '.join(APPS)}",
+      choices=APPS,
+      default='bash')
+
+  parser.add_argument(
+      '-b', '--basis',
+      help="",
+      type=Path,
+      default=None)
+
+  parser.add_argument(
+      '--init',
+      dest='init',
+      action='store_true',
+      help="Create and initialize basis directory if it doesn't exist")
+
+  parser.add_argument(
+    '--python',
+    type=str,
+    default=_PY)
+
+  parser.add_argument(
+      '-w', '--work',
+      help="",
+      type=Path,
+      default=Path('/'))
+
+  parser.add_argument(
+      '-c', '--cwd',
+      help="",
+      type=Path,
+      default=Path.cwd())
+
+  # cmd (positional, collects all remaining)
+  # Using REMAINDER so everything after this argument is captured "as-is."
+  parser.add_argument(
+    'cmd',
+    nargs='*',
+    help="Command and its arguments")
+
+  args = parser.parse_args()
+
+  if args.init:
+    image = args.image
+
+    if image is None:
+      image = DEFAULT_IMAGE
+
+    if init(
+      image = image,
+      basis = args.basis,
+      cwd = args.cwd,
+      python = args.python):
+
+      return 1
+
+  return run(
+    image = args.image,
+    basis = args.basis,
+    app = args.app,
+    work = args.work,
+    cwd = args.cwd,
+    cmd = args.cmd)
+
+#===============================================================================
+def find_basis(start):
+  tmp = start
+  while tmp.name:
+    if (tmp/'.basis').exists():
+      return tmp/'.basis'
+
+    tmp = tmp.parent
+
+  return None
+
+#===============================================================================
+exit(main())

partis_basis-0.0.4.dist-info/LICENSE.txt

@@ -0,0 +1,50 @@
+#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
+partis-basis
+
+Copyright (c) 2023, Nanohmics, Inc.
+All rights reserved.
+
+#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
+
+Software Notice
+
+Nanohmics, Inc. shall not be liable to any party for direct, indirect,
+special, incidental, or consequential damages arising out of the use of
+this software and/or its documentation. Nanohmics, Inc. specifically
+disclaims any warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose. The
+software and accompanying documentation, if any, provided hereunder is
+provided "AS IS". Nanohmics, Inc. has no obligation to provide maintenance,
+support, updates, enhancements, or modifications.
+
+#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above
+    copyright notice, this list of conditions and the following
+    disclaimer in the documentation and/or other materials provided
+    with the distribution.
+
+  * Neither the name of the copyright holder nor the names of any
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#

partis_basis-0.0.4.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: partis-basis
+Version: 0.0.4
+Requires-Python: >=3.7.2
+Author: Nanohmics Inc
+Summary: 
+License-File: LICENSE.txt
+Description-Content-Type: text/markdown
+
+CLI utility for using Singularity container as virtual environment (requires singularity to already be installed).
+
+```
+$ basis --help
+Usage: basis [OPTIONS] [CMD]...
+
+Options:
+  -i, --image TEXT
+  -a, --app TEXT    {bash, fish, jupyter, code}
+  -b, --basis PATH
+  -w, --work PATH
+  -c, --cwd PATH
+  --help            Show this message and exit.
+```
+
+The first time it is run it will download a pre-build Singularity image.
+You must also tell it where to create the basis directory on the first run, which
+will become a virtual home inside the container.
+
+```bash
+$ basis -b ./.basis
+image: library://kcdodd/basis/ubuntu-22.04-basis:0.0.1
+  app: fish
+basis: /path/to/cwd/.basis
+ work: /
+  cwd: /path/to/cwd
+  cmd:
+Entering container...
+INFO:    Using cached image
+Loading python/3.11.0/gcc-system
+  Loading requirement: gcc/system/default
+Creating environment: /basis/envs/default
+Creating modulefile /basis/mods/environment/default
+Loading environment: /basis/envs/default
+Saved modules to /basis/envs/default/modules
+gcc/system/default python/3.11.0/gcc-system environment/default
+Loading environment: /basis/envs/default
+Welcome to fish, the friendly interactive shell
+Type help for instructions on how to use fish
+>? ok | 10:43:13 | 0ms
+>[S] user@hostname | (default) | /work/path/to/cwd
+>$ echo $HOME
+/basis
+>? ok | 10:55:36 | 0ms
+>[S] user@hostname | (default) | /work/path/to/cwd
+>$ which python
+/basis/envs/default/bin/python
+>? ok | 10:59:06 | 6ms
+>[S] user@hostname | (default) | /work/path/to/cwd
+>$ exit
+... Exited container
+```
+
+Safely delete basis directory to start over.
+
+```
+rm -r ./.basis

partis_basis-0.0.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+partis_basis-0.0.4.data/purelib/partis/basis/__main__.py,sha256=rP-Am6T6X5Lj91QUugS2qAd_lgXqjHFw5r870WSA1s4,7529
+partis_basis-0.0.4.dist-info/METADATA,sha256=f31zNX1bAjZfSoFuVdECJxt-rW8Sd4GkBIaK_uvQbmw,1786
+partis_basis-0.0.4.dist-info/LICENSE.txt,sha256=qf-NluVHxh7dSBPryN3syTEA_225NVd9r158uA_mR7c,2416
+partis_basis-0.0.4.dist-info/top_level.txt,sha256=T72LF-bUK7nMDf1GQgbzvgZ2YrJElwwRd9h7HwVQBIQ,6
+partis_basis-0.0.4.dist-info/entry_points.txt,sha256=RvrdAbgkHvUSP_dSAm8dumDtAfIHV2nCbq6bRpm7BZY,54
+partis_basis-0.0.4.dist-info/WHEEL,sha256=OmYjmrwnZ_TEyF-NYtpim7LB9zEz0oAjizteYuA5HsA,133
+partis_basis-0.0.4.dist-info/RECORD,,

partis_basis-0.0.4.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: partis.pyproj.dist_file.dist_binary.dist_binary_wheel
+Root-Is-Purelib: true
+Tag: py3-none-any
+Build: 
+

partis_basis-0.0.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+basis = partis.basis.__main__:main
+

partis_basis-0.0.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+partis