Command Line Interface

Many core signac functions are — in addition to the Python interface — accessible directly via the $ signac command line interface (CLI).

CLI Overview

The available commands in the CLI can be shown by executing $ signac --help:

$ signac --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

The commands can be roughly grouped by task, ordered by frequency of use:

Using a project:
Modifying a project:
Sharing and archiving a project:

clone

$ signac clone --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

config

$ signac config --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

diff

$ signac diff --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

document

$ signac document --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

export

$ signac export --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

find

$ signac find --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

import

$ signac import --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

init

$ signac init --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

job

$ signac job --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

move

$ signac move --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

rm

$ signac rm --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

schema

$ signac schema --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

shell

$ signac shell --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

statepoint

$ signac statepoint --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

sync

$ signac sync --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

update-cache

$ signac update-cache --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'

view

$ signac view --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/bin/signac", line 5, in <module>
    from signac.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/__init__.py", line 18, in <module>
    from .project import Project, TemporaryProject, get_job, get_project, init_project
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/project.py", line 26, in <module>
    from .config import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-core/envs/latest/lib/python3.11/site-packages/signac/config.py", line 9, in <module>
    from ._vendor.configobj import ConfigObj, ConfigObjError
ModuleNotFoundError: No module named 'signac._vendor'