LOGS-Py
LOGS is a scientific data management system (SDMS) software allowing for automated data collection, visualization, and organization. Within its internal organizational concepts, it allows you to enrich your experimental data with metadata. LOGS allows you to adapt many of its organization structures, which enables your data management to follow your internal workflows.
LOGS-Py is a Python package interacting with the LOGS web API to enable you to extract and push data to LOGS and generally to interact with the LOGS backend in a programmatic way. The main motivation behind the design of the library is to keep this interaction as pythonic as possible. The communication with the API remains mainly in the background, while the user of the library handles native Python objects. Thereby, the user is still able to interact with nearly all LOGS functionalities and entities.
Thus, this library firstly targets lab and data scientist, allowing them to freely interact with experimental data and its metadata without any pre-knowledge of Web technologies and communication. Secondly, it facilitates power-users to implement highly specific workflow automations and 3rd-party software integrations with LOGS and other lab software.
Installation
The LOGS-Py package can be easily installed using pip
.
For this, open the terminal
and do:
pip install logs-py
Overview
Please find below the overview of LOGS-Py documentation.
- LOGS
- Entities package
- FormattedTable package
- LabNotebookEntryContent package
- AutoloadClientInfo
- AutoloadFileInfo
- AutoloadStatus
- AutoloadStatusError
- AxisNaming
- Bridge
- BridgeMinimal
- BridgeRelations
- BridgeRequestParameter
- BridgeType
- Bridges
- CustomField
- CustomFieldMinimal
- CustomFieldModels
- CustomFieldRelations
- CustomFieldRequestParameter
- CustomFieldValue
- CustomFieldValueConverter
- CustomFields
- CustomSchema
- CustomSchemaParameter
- CustomSchemaSection
- CustomType
- CustomTypeEntityType
- CustomTypeMinimal
- CustomTypeRelations
- CustomTypeRequestParameter
- CustomTypeSection
- CustomTypes
- DataSource
- DataSourceMinimal
- DataSourceRelations
- DataSourceRequestParameter
- DataSourceStatus
- DataSources
- Dataset
- DatasetCreator
- DatasetInfo
- DatasetMatchTypes
- DatasetMatching
- DatasetMinimal
- DatasetModels
- DatasetRelations
- DatasetRequestParameter
- DatasetUploadParameter
- Datasets
- Datatrack
- DatatrackFormattedTable
- DatatrackGeneric
- DatatrackImage
- DatatrackNumericArray
- DatatrackNumericMatrix
- Document
- DocumentRelations
- DocumentRequestParameter
- Documents
- Entities
- EntitiesRequestParameter
- EntityOriginWriteModelWithId
- Equipment
- EquipmentMinimal
- Experiment
- ExperimentMinimal
- ExperimentRelations
- ExperimentRequestParameter
- Experiments
- FileEntry
- FileExcludePattern
- Format
- FormatFormat
- FormatFormatMinimal
- FormatFormatRequestParameter
- FormatFormats
- FormatInstrument
- FormatInstrumentMinimal
- FormatInstrumentRequestParameter
- FormatInstruments
- FormatMetaData
- FormatMethod
- FormatMethodMinimal
- FormatMethodRequestParameter
- FormatMethods
- FormatMinimal
- FormatRequestParameter
- FormatVendor
- FormatVendorMinimal
- FormatVendorRequestParameter
- FormatVendors
- Formats
- HierarchyLeaf
- HierarchyNode
- ICustomSchemaRequest
- ILiterarTypedEntity
- IRelatedEntityRequest
- Instrument
- InstrumentMinimal
- InstrumentRelations
- InstrumentRequestParameter
- Instruments
- Inventories
- Inventory
- InventoryMinimal
- InventoryRelations
- InventoryRequestParameter
- LabNotebook
- LabNotebookEntries
- LabNotebookEntry
- LabNotebookEntryMinimal
- LabNotebookEntryRelations
- LabNotebookEntryRequestParameter
- LabNotebookExperiment
- LabNotebookExperimentMinimal
- LabNotebookExperimentRequestParameter
- LabNotebookExperiments
- LabNotebookMinimal
- LabNotebookModels
- LabNotebookRequestParameter
- LabNotebooks
- Method
- MethodMinimal
- MethodRelations
- MethodRequestParameter
- Methods
- Origin
- OriginMinimal
- OriginRequestParameter
- Origins
- ParserLog
- Person
- PersonCategory
- PersonMinimal
- PersonRelations
- PersonRequestParameter
- Persons
- Project
- ProjectMinimal
- ProjectPersonPermission
- ProjectRelations
- ProjectRequestParameter
- Projects
- Role
- RoleMinimal
- RoleRelations
- RoleRequestParameter
- Roles
- RunState
- Sample
- SampleMinimal
- SampleRelations
- SampleRequestParameter
- Samples
- Track
- TrackData
- TrackImage
- TrackImageData
- TrackMatrix
- TrackMatrixData
- TrackSettings
- TrackTable
- TrackTableData
- TrackXY
- TrackXYComplex
- TrackXYComplexData
- TrackXYData