API

This API allows interacting with a collection of frictionless datapackages, stored in a specific format, explore the content of its entries and visualize the underlying data.

A Collection of datapackages, denoted as entries can be created from local files or a remote repository. The metadata describing the data are stored as descriptors and can be accessed via metadata objects. For collections containing a certain type of data, collections with specific methods can be created, such as with Echemdb. In a same way, specific types of entries can be created, such as with EchemdbEntry

Core Modules:

• unitpackage.collection
  • Collection
    • Collection.Entry
      • Collection.Entry.add_columns()
      • Collection.Entry.add_offset()
      • Collection.Entry.apply_scaling_factor()
      • Collection.Entry.create_example()
      • Collection.Entry.default_metadata_key
      • Collection.Entry.df
      • Collection.Entry.field_unit()
      • Collection.Entry.fields
      • Collection.Entry.from_csv()
      • Collection.Entry.from_df()
      • Collection.Entry.from_local()
      • Collection.Entry.identifier
      • Collection.Entry.load_metadata()
      • Collection.Entry.metadata
      • Collection.Entry.plot()
      • Collection.Entry.remove_column()
      • Collection.Entry.remove_columns()
      • Collection.Entry.rename_field()
      • Collection.Entry.rename_fields()
      • Collection.Entry.rescale()
      • Collection.Entry.save()
      • Collection.Entry.update_fields()
    • Collection.create_example()
    • Collection.filter()
    • Collection.from_local()
    • Collection.from_local_file()
    • Collection.from_remote()
    • Collection.identifiers
    • Collection.rescale()
    • Collection.save_entries()
• unitpackage.entry
  • Entry
    • Entry.add_columns()
    • Entry.add_offset()
    • Entry.apply_scaling_factor()
    • Entry.create_example()
    • Entry.default_metadata_key
    • Entry.df
    • Entry.field_unit()
    • Entry.fields
    • Entry.from_csv()
    • Entry.from_df()
    • Entry.from_local()
    • Entry.identifier
    • Entry.load_metadata()
    • Entry.metadata
    • Entry.plot()
    • Entry.remove_column()
    • Entry.remove_columns()
    • Entry.rename_field()
    • Entry.rename_fields()
    • Entry.rescale()
    • Entry.save()
    • Entry.update_fields()
• unitpackage.descriptor
  • Descriptor()
  • GenericDescriptor
    • GenericDescriptor.yaml
  • QuantityDescriptor
    • QuantityDescriptor.quantity
• unitpackage.metadata
  • MetadataDescriptor
    • MetadataDescriptor.from_dict()
    • MetadataDescriptor.from_json()
    • MetadataDescriptor.from_yaml()
• unitpackage.entrypoint
• unitpackage.remote
  • collect_datapackages()
  • collect_zipfile_from_url()
• unitpackage.local
  • collect_datapackages()
  • collect_resources()
  • create_df_resource_from_csv()
  • create_df_resource_from_df()
  • create_df_resource_from_tabular_resource()
  • create_tabular_resource_from_csv()
  • create_unitpackage()
  • update_fields()
  • write_metadata()

Database Modules:

• unitpackage.database.echemdb
  • Echemdb
    • Echemdb.EchemdbEntry
      • Echemdb.EchemdbEntry.bibliography
      • Echemdb.EchemdbEntry.citation()
      • Echemdb.EchemdbEntry.default_metadata_key
      • Echemdb.EchemdbEntry.from_mpt()
      • Echemdb.EchemdbEntry.get_electrode()
      • Echemdb.EchemdbEntry.plot()
      • Echemdb.EchemdbEntry.rescale()
      • Echemdb.EchemdbEntry.rescale_reference()
      • Echemdb.EchemdbEntry.rescale_scan_rate()
      • Echemdb.EchemdbEntry.scan_rate
      • Echemdb.EchemdbEntry.thumbnail()
    • Echemdb.Entry
    • Echemdb.bibliography
    • Echemdb.describe()
    • Echemdb.materials()
• unitpackage.database.echemdb_entry
  • EchemdbEntry
    • EchemdbEntry.bibliography
    • EchemdbEntry.citation()
    • EchemdbEntry.default_metadata_key
    • EchemdbEntry.from_mpt()
    • EchemdbEntry.get_electrode()
    • EchemdbEntry.plot()
    • EchemdbEntry.rescale()
    • EchemdbEntry.rescale_reference()
    • EchemdbEntry.rescale_scan_rate()
    • EchemdbEntry.scan_rate
    • EchemdbEntry.thumbnail()

Electrochemistry Modules:

• unitpackage.electrochemistry.reference_electrode
  • ReferenceElectrode()

Loaders:

• unitpackage.loaders.baseloader
  • BaseLoader
    • BaseLoader.column_header_lines
    • BaseLoader.column_header_names
    • BaseLoader.column_headers
    • BaseLoader.create()
    • BaseLoader.data
    • BaseLoader.decimal
    • BaseLoader.delimiter
    • BaseLoader.df
    • BaseLoader.file
    • BaseLoader.header
    • BaseLoader.header_lines
    • BaseLoader.known_loaders()
    • BaseLoader.metadata
• unitpackage.loaders.eclabloader
  • ECLabLoader
    • ECLabLoader.header_lines
• unitpackage.loaders.gamryloader
  • GamryLoader
    • GamryLoader.column_header_lines
    • GamryLoader.header_lines
• unitpackage.loaders.eclab_fields