Uploaded image for project: 'The Virtual Brain'
  1. The Virtual Brain
  2. TVB-2980 TVB-KG integration
  3. TVB-3030

Update documentation for command line usage of siibra in TVB

    XMLWordPrintable

Details

    • Sub-task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 2.7
    • None
    • VBC Sprint 14

    Description

      The current notebooks under tvb_documentation/demos/siibra do not use the latest API available in the TVB codebase for interacting with siibra. The siibra_tvb_api.ipynb notebook should be updated, removing the section regarding the API creation and leaving just the API Usage section. For this section I propose showcasing 3 APIs:

      1. API for extracting just Structural Connectivities -> get_tvb_connectivities_from_kg()
      2. API for extracting just Functional Connectivities -> get_connectivity_measures_from_kg()
      3. API for extracting both types of Connectivities with a single call -> get_connectivities_from_kg()

      The rest of the siibra notebooks showcase just how to extract different elements from the KG using siibra, so they don't really need any update.

      Gliffy Diagrams

        Attachments

          Activity

            People

              romina.baila Romina Baila
              romina.baila Romina Baila
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 4 hours Original Estimate - 4 hours
                  4h
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 6 hours
                  6h