signac Logo
latest
  • Go to Framework Documentation
  • Installation
    • Install with conda
    • Install with pip
    • Source Code Installation
    • Optional dependencies
  • Command Line Interface
    • CLI Overview
    • clone
    • config
    • diff
    • document
    • export
    • find
    • import
    • init
    • job
    • move
    • rm
    • schema
    • shell
    • statepoint
    • sync
    • update-cache
    • view
  • API Reference
    • The Project
      • Project
        • Project.FN_CACHE
        • Project.FN_DOCUMENT
        • Project.KEY_DATA
        • Project.check()
        • Project.clone()
        • Project.config
        • Project.create_linked_view()
        • Project.data
        • Project.detect_schema()
        • Project.doc
        • Project.document
        • Project.export_to()
        • Project.find_jobs()
        • Project.fn()
        • Project.get_job()
        • Project.get_project()
        • Project.groupby()
        • Project.import_from()
        • Project.init_project()
        • Project.isfile()
        • Project.min_len_unique_id()
        • Project.open_job()
        • Project.path
        • Project.repair()
        • Project.stores
        • Project.sync()
        • Project.temporary_project()
        • Project.to_dataframe()
        • Project.update_cache()
        • Project.workspace
    • The JobsCursor class
      • JobsCursor
        • JobsCursor.export_to()
        • JobsCursor.groupby()
        • JobsCursor.to_dataframe()
    • The Job class
      • Job
        • Job.FN_DOCUMENT
        • Job.FN_STATE_POINT
        • Job.KEY_DATA
        • Job.clear()
        • Job.close()
        • Job.data
        • Job.doc
        • Job.document
        • Job.fn()
        • Job.id
        • Job.init()
        • Job.isfile()
        • Job.move()
        • Job.open()
        • Job.path
        • Job.project
        • Job.remove()
        • Job.reset()
        • Job.sp
        • Job.statepoint
        • Job.stores
        • Job.sync()
        • Job.update_statepoint()
    • The JSONDict
      • JSONDict
    • The H5Store
      • H5Store
        • H5Store.clear()
        • H5Store.close()
        • H5Store.file
        • H5Store.filename
        • H5Store.flush()
        • H5Store.get()
        • H5Store.items()
        • H5Store.keys()
        • H5Store.mode
        • H5Store.open()
        • H5Store.pop()
        • H5Store.popitem()
        • H5Store.setdefault()
        • H5Store.update()
        • H5Store.values()
    • The H5StoreManager
      • H5StoreManager
        • H5StoreManager.cls
        • H5StoreManager.keys()
        • H5StoreManager.prefix
    • Top-level functions
      • TemporaryProject()
      • buffered()
      • diff_jobs()
      • get_buffer_capacity()
      • get_current_buffer_size()
      • get_job()
      • get_project()
      • init_project()
      • is_buffered()
      • set_buffer_capacity()
    • Submodules
      • signac.sync module
        • DocSync
        • FileSync
        • sync_jobs()
        • sync_projects()
      • signac.warnings module
      • signac.errors module
        • ConfigError
        • DestinationExistsError
        • DocumentSyncConflict
        • Error
        • FileSyncConflict
        • H5StoreAlreadyOpenError
        • H5StoreClosedError
        • IncompatibleSchemaVersion
        • InvalidKeyError
        • JobsCorruptedError
        • KeyTypeError
        • SchemaSyncConflict
        • StatepointParsingError
        • SyncConflict
        • WorkspaceError
  • Changelog
    • Version 2
      • [2.0.0] – 2021-xx-xx
        • Added
        • Changed
        • Removed
    • Version 1
      • [1.8.0] – 2022-10-05
        • Added
        • Changed
        • Deprecated
        • Fixed
        • Removed
      • [1.7.0] – 2021-06-08
        • Added
        • Changed
        • Deprecated
        • Fixed
      • [1.6.0] – 2021-01-24
        • Added
        • Changed
        • Deprecated
        • Fixed
      • [1.5.1] – 2020-12-19
        • Added
        • Changed
      • [1.5.0] – 2020-09-20
        • Added
        • Changed
        • Fixed
        • Deprecated
        • Removed
      • [1.4.0] – 2020-02-28
        • Added
        • Changed
        • Fixed
        • Removed
      • [1.3.0] – 2019-12-20
        • Added
        • Changed
        • Fixed
        • Deprecated
        • Removed
      • [1.2.0] – 2019-07-22
        • Added
        • Fixed
        • Deprecated
      • [1.1.0] – 2019-05-19
        • Added
        • Fixed
        • Removed
      • [1.0.0] – 2019-02-28
        • Added
        • Changed
        • Fixed
        • Removed
    • Version 0.9
      • [0.9.5] – 2019-01-31
        • Fixed
      • [0.9.4] – 2018-10-24
        • Added
        • Changed
        • Fixed
      • [0.9.3] – 2018-06-14
        • Added
        • Fixed
      • [0.9.2] – 2017-12-18
        • Added
        • Changed
        • Fixed
      • [0.9.1] – 2017-11-07
        • Fixed
      • [0.9.0] – 2017-10-28
        • Added
        • Changed
    • Version 0.8
      • [0.8.7] – 2017-10-05
        • Fixed
      • [0.8.6] – 2017-08-25
        • Fixed
      • [0.8.5] – 2017-06-07
        • Changed
        • Fixed
      • [0.8.4] – 2017-05-19
        • Added
        • Changed
      • [0.8.3] – 2017-05-10
        • Changed
        • Fixed
      • [0.8.2] – 2017-04-19
        • Fixed
      • [0.8.1] – 2017-04-17
        • Fixed
      • [0.8.0] – 2017-04-16
        • Added
        • Changed (breaking API)
        • Changed (non-breaking)
        • Deprecated
        • Fixed
    • Version 0.7
      • [0.7.1] – 2017-01-09
        • Added
        • Changed
        • Fixed
      • [0.7.0] – 2017-01-04
        • Added
        • Changed
        • Fixed
        • Removed
    • Version 0.6
      • [0.6.2] – 2017-12-15
        • Added
        • Removed
      • [0.6.1] – 2017-11-26
        • Changed
        • Fixed
      • [0.6.0] – 2016-11-18
        • Added
        • Changed
        • Removed
        • Fixed
    • Version 0.5
      • [0.5.0] – 2016-08-31
        • Added
        • Changed
    • Version 0.4
      • [0.4.0] – 2016-08-05
        • Added
        • Changed
        • Removed
    • Version 0.3
      • [0.3.0] – 2016-06-23
        • Added
        • Changed
    • Version 0.2
      • [0.2.9] – 2016-06-06
        • Added
        • Changed
        • Fixed
        • Deprecated
      • [0.2.8] – 2016-04-18
        • Added
        • Changed
      • [0.2.7] – 2016-02-29
        • Added
        • Changed
      • [0.2.6] – 2016-02-20
        • Added
        • Changed
        • Fixed
      • [0.2.5] – 2016-02-10
        • Added
        • Changed
        • Deprecated
        • Fixed
      • [0.2.4] – 2016-01-11
        • Added
        • Changed
        • Fixed
      • [0.2.3] – 2015-12-09
        • Fixed
      • [0.2.2] – 2015-11-30
        • Fixed
      • [0.2.1] – 2015-11-29
        • Added
      • [0.2.0] – 2015-11-05
  • Support and Development
    • Code contributions
      • Set up a development environment
      • The development workflow
      • Testing
      • Benchmarking
      • Building documentation
      • Updating the changelog
signac
  • signac (core) package documentation
  • Edit on GitHub

signac (core) package documentation¶

Note

This is documentation for the signac core package, which is part of the signac framework. See here for a comprehensive introduction to the signac framework.

Contents¶

  • Installation
    • Install with conda
    • Install with pip
    • Source Code Installation
    • Optional dependencies
  • Command Line Interface
    • CLI Overview
    • clone
    • config
    • diff
    • document
    • export
    • find
    • import
    • init
    • job
    • move
    • rm
    • schema
    • shell
    • statepoint
    • sync
    • update-cache
    • view
  • API Reference
    • The Project
    • The JobsCursor class
    • The Job class
    • The JSONDict
    • The H5Store
    • The H5StoreManager
    • Top-level functions
    • Submodules
  • Changelog
    • Version 2
    • Version 1
    • Version 0.9
    • Version 0.8
    • Version 0.7
    • Version 0.6
    • Version 0.5
    • Version 0.4
    • Version 0.3
    • Version 0.2
  • Support and Development
    • Code contributions

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Next

© Copyright The Regents of the University of Michigan. Revision f8461424.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
v1.8.0
v1.7.0
v1.6.0
v1.5.1
v1.5.0
v1.4.0
v1.3.0
v1.2.0
v1.1.0
v1.0.0
v0.9.5
v0.8.7
v0.7.1
v0.6.2
v0.5.0
v0.4.0
v0.3.0
numpy_docs
next
Downloads
On Read the Docs
Project Home
Builds