Skip to main content
`Ctrl`+`K`

# `rsciio`

`__version__` | str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
`IO_PLUGINS` | List of available IO plugins.
`set_log_level` | Convenience function to set the log level of all rsciio modules.

rsciio.__version__: str

  The version of the RosettaSciIO package.

rsciio.IO_PLUGINS

  List of available IO plugins.

  Each entry is a dictionary with the following keys:

  - `'name'`: The name of the plugin.

  - `'name_aliases'`: A list of alternative names for the plugin.

  - `'description'`: A brief description of the plugin.

  - `'full_support'`: A boolean indicating if the plugin has full support.

  - `'default_extension'`: The default file extension for the plugin.

  - `'writes'`: A boolean indicating if the plugin supports writing files.

  - `'non_uniform_axis'`: A boolean indicating if the plugin supports non-uniform axes.

  - `'api'`: The API module path as a string (e.g., ‘rsciio.nexus’).

rsciio.set_log_level(level)

  Convenience function to set the log level of all rsciio modules.

  Note: The log level of all other modules are left untouched.

  Parameters:
    level `python:int` or `python:str`

      The log level to set. Any values that `logging.Logger.setLevel()` accepts are valid. The default options are:

      - ‘CRITICAL’

      - ‘ERROR’

      - ‘WARNING’

      - ‘INFO’

      - ‘DEBUG’

      - ‘NOTSET’

  Examples

  For normal logging of rsciio functions, you can set the log level like this:

      >>> import rsciio
      >>> rsciio.set_log_level('INFO')
      >>> from rsciio.digitalmicrograph import file_reader
      >>> file_reader('my_file.dm3')
      INFO:rsciio.digital_micrograph:DM version: 3
      INFO:rsciio.digital_micrograph:size 4796607 B
      INFO:rsciio.digital_micrograph:Is file Little endian? True
      INFO:rsciio.digital_micrograph:Total tags in root group: 15