sirepo.pkcli package¶

Common pkcli operations

copyright:: Copyright (c) 2022 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.import_module(type_or_data)[source]¶

Load the simulation_type pkcli module

Parameters:: type_or_data (str or dict) – simulation type or description
Returns:: simulation type module instance
Return type:: module

Submodules¶

sirepo.pkcli.activait module¶

sirepo.pkcli.admin module¶

sirepo.pkcli.auth module¶

copyright:: Copyright (c) 2018 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.auth.gen_private_key()[source]¶: Generate 32 byte random private key

sirepo.pkcli.canvas module¶

sirepo.pkcli.controls module¶

sirepo.pkcli.cortex module¶

sirepo.pkcli.dev module¶

sirepo.pkcli.devtools module¶

sirepo.pkcli.devtools.rename_app(old_app_name, new_app_name)[source]¶

sirepo.pkcli.elegant module¶

sirepo.pkcli.elegant_schema module¶

transliterate elegant manual into sirepo schema format

copyright:: Copyright (c) 2024 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.elegant_schema.parse_manual()[source]¶

sirepo.pkcli.epicsllrf module¶

sirepo.pkcli.flash module¶

Wrapper to run FLASH from the command line.

copyright:: Copyright (c) 2018 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.flash.run(cfg_dir)[source]¶

sirepo.pkcli.genesis module¶

sirepo.pkcli.hellweg module¶

sirepo.pkcli.impactt module¶

sirepo.pkcli.impactx module¶

sirepo.pkcli.job_agent module¶

Agent for managing the execution of jobs.

copyright:: Copyright (c) 2019 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.job_agent.start()[source]¶

sirepo.pkcli.job_agent.start_sbatch()[source]¶

sirepo.pkcli.job_cmd module¶

sirepo.pkcli.job_supervisor module¶

sirepo.pkcli.jspec module¶

sirepo.pkcli.jupyterhublogin module¶

CLI for jupyterhublogin

copyright:: Copyright (c) 2021 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.jupyterhublogin.create_user(email, display_name)[source]¶

Create a JupyterHubUser

This is idempotent. It will create a Sirepo email user if none exists for the email before creating a jupyterhub user

It will update the user’s display_name if the one supplied is different than the one in the db.

Parameters:

email (str) – Email of user to create.
display_name (str) – UserRegistration display_name

Returns:

The jupyterhub user_name of the user

Return type:

user_name (str)

sirepo.pkcli.jupyterhublogin.unknown_user_dirs()[source]¶

Directory names for Jupyter users that are not in database. Excludes directories that begin with capital letter.

Returns:: directories for Jupyter users that are not in the database.
Return type:: list

sirepo.pkcli.madx module¶

sirepo.pkcli.madx_device_server module¶

sirepo.pkcli.myapp module¶

sirepo.pkcli.nersc_test module¶

Allow NERSC to run tests of Sirepo images in their infrastructure

copyright:: Copyright (c) 2023 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.nersc_test.sequential(pkunit_deviance=None)[source]¶

Test sequential process for use by NERSC inside SHIFTER

Simulates the operation that Sirepo does when it executes a sequential process on a login node in SHIFTER.

On success, will return (output) nersc_test.sequential PASS

Parameters:: pkunit_deviance (str) – used only by internal unit test to test deviance case
Returns:: PASS or fail with diagnostic information
Return type:: str

sirepo.pkcli.omega module¶

Wrapper to run omega from the command line.

copyright:: Copyright (c) 2023 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.omega.run_background(cfg_dir)[source]¶

sirepo.pkcli.opal module¶

sirepo.pkcli.openmc module¶

sirepo.pkcli.radia module¶

sirepo.pkcli.raydata module¶

sirepo.pkcli.roles module¶

sirepo.pkcli.service module¶

Runs API server and job supervisor

Also supports starting nginx proxy.

copyright:: Copyright (c) 2015-2023 RadiaSoft LLC. All Rights Reserved.
license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.service.http()[source]¶

Starts the server and job_supervisor.

Used for development only.

sirepo.pkcli.service.jupyterhub()[source]¶

sirepo.pkcli.service.nginx_proxy()[source]¶

Starts nginx in container.

Used for development only.

sirepo.pkcli.service.server()[source]¶

sirepo.pkcli.service.tornado()[source]¶

sirepo.pkcli.setup_dev module¶

setup development directory

license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.setup_dev.default_command()[source]¶

sirepo.pkcli.shadow module¶

sirepo.pkcli.silas module¶

Wrapper to run SILAS from the command line.

license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.silas.run_background(cfg_dir)[source]¶

sirepo.pkcli.sim_data module¶

sirepo.pkcli.srw module¶

Wrapper to run SRW from the command line.

license:: http://www.apache.org/licenses/LICENSE-2.0.html

sirepo.pkcli.srw.python_to_json(run_dir='.', in_py='in.py', out_json='out.json')[source]¶

Run importer in run_dir trying to import py_file