enpi_api.examples
Examples
This page and the underlying pages show a set of examples for various common use cases when working with the SDK.
File management
Various examples displaying how to interact with files.
Click here to view the examples.
Apps
Various examples displaying how to run apps on the ENPICOM Platform using the SDK.
Click here to view the examples.
Import clone collections
Examples on how to upload new clone collections from the uploaded files. Clone collections, which contain clones and sequences inside of them, are the primarly input for most of the applications and modules available in the ENPICOM-Platform. It's worth noting that the input files for clone collection must follow a set of rules and have to contain a number of mandatory columns. See documentation here for more details on this behavior.
Click here to view the examples.
Retrieve clones and download them
Various examples showcasing how you can retrieve clones from the ENPICOM Platform and download them to your local machine.
Click here to view the examples.
Assign metadata to collections, clones or sequences
Various examples showcasing how you can assign metadata to collections, clones or sequences.
Click here to view the examples.
Browse available references
Browse available reference databases and their revisions, fetch them all or get only one. Knowledge of available references and their revisions may be required e.g. in order to correctly configure a Sequence Annotation run.
Click here to view the examples.
Create and browse tags
Browse available tag archetypes, fetch them all or get only one, create new ones.
Click here to view the examples.
Filters
Filters are a tool for selecting only the part of the data you're interested when working with various ENPICOM Public API functionalities, e.g. exports. They allow matching on IDs (sequence, clone, collection) or tag values, can be nested and allow applying complex logic operations.
Click here to view the examples.
Listen to events
Using the SDK it is possible to listen to events that are emitted by the ENPICOM Platform.
For more information on events, and which events are available, please refer to the Events documentation.
Click here to view the examples.
Change logger settings
Ways to control the amount of logs and debug info printed by SDK functions.
Click here to view the examples.
1''' 2# Examples 3 4This page and the underlying pages show a set of examples for various common use cases when working with the SDK. 5 6 7## File management 8Various examples displaying how to interact with files. 9 10 11Click [**here**](./examples/file_management.html) to view the examples. 12## Apps 13Various examples displaying how to run apps on the ENPICOM Platform using the SDK. 14 15 16Click [**here**](./examples/apps.html) to view the examples. 17## Import clone collections 18Examples on how to upload new clone collections from the uploaded files. 19Clone collections, which contain clones and sequences inside of them, are the primarly input for most of the applications and modules available in the ENPICOM-Platform. 20It's worth noting that the input files for clone collection must follow a set of rules and have to contain a number of 21mandatory columns. See [documentation here](https://igx.bio/public-api/v1/public/docs/python_sdk/enpi_api/l2/client/api/collection_api.html#CollectionApi.create_collection_from_csv) 22for more details on this behavior. 23 24 25 26Click [**here**](./examples/import_collections.html) to view the examples. 27## Retrieve clones and download them 28Various examples showcasing how you can retrieve clones from the ENPICOM Platform and download them to your local machine. 29 30 31Click [**here**](./examples/retrieve_clones.html) to view the examples. 32## Assign metadata to collections, clones or sequences 33Various examples showcasing how you can assign metadata to collections, clones or sequences. 34 35 36Click [**here**](./examples/assign_metadata.html) to view the examples. 37## Browse available references 38Browse available reference databases and their revisions, fetch them all or get only one. 39Knowledge of available references and their revisions may be required e.g. in order to correctly configure a Sequence Annotation run. 40 41 42Click [**here**](./examples/references.html) to view the examples. 43## Create and browse tags 44Browse available tag archetypes, fetch them all or get only one, create new ones. 45 46 47Click [**here**](./examples/tags.html) to view the examples. 48## Filters 49Filters are a tool for selecting only the part of the data you're interested when working with various 50ENPICOM Public API functionalities, e.g. exports. They allow matching on IDs (sequence, clone, collection) or tag values, can be nested 51and allow applying complex logic operations. 52 53 54Click [**here**](./examples/filters.html) to view the examples. 55## Listen to events 56Using the SDK it is possible to listen to events that are emitted by the ENPICOM Platform. 57 58For more information on events, and which events are available, please refer to the [Events](/public-api/v1/public/docs/events/) documentation. 59 60 61 62Click [**here**](./examples/events.html) to view the examples. 63## Change logger settings 64Ways to control the amount of logs and debug info printed by SDK functions. 65 66 67Click [**here**](./examples/logger.html) to view the examples. 68'''