DRC & o2S API

[drniiken]

• Extend existing APIs (computational API, study creation and access, platform API), add new APIs (progress API, import/export API) as required by users and in support of the DRC APIs, exposing:
  • queuering of service & study input/output port descriptions
  • search for compatible services to a data item (initially based on mime-type, potentially later extensible based on file-level meta-data annotation)
  • launching of computational study with given input parameters / data; initially focusing on similar use-cases as the Portal-launched simulations
• Access to logs after job was run
• API for import/export of data
• Instantiation of a study that contains a file import service that already points to the given data-item and an attached visualization/analysis/processing user-requested service (user-login dependant)
• The above functionality accepting data and input will support data pointers from the DRC API

Deliverable: The above described o²S²PARC / DRC API (and Python client) functionality

Tasks

Preview Give feedback

1. Upgrade version when new client (with functionality above) is released @bisgaard-itis

Baklava

Preview Give feedback

1. M12 API tutorial #710
   2 of 4
   PO issue y6 +2
   

   
2. M1-12 Support MAP-Core for simulations on the Portal #681
   Epic PO issue y6 +3
   
3. M10 API for import and export of data #690
   PO issue y6 +2
   
4. M10 Accept Pointers from DRC API #692
   PO issue y6 +2
   

Watermelon

Preview Give feedback

1. Integration of osparc as O2SparcService nih-sparc/sparc.client#7
   enhancement +1
   
2. Increase test coverage in osparc and other minor fixes nih-sparc/sparc.client#19
   enhancement +1
   
3. ✨ Extends o2sparc client functionality nih-sparc/sparc.client#17
   +0
   

[pcrespov]

Update on sprint Vaporwave

Done

• First meeting with all cores on the API (@pcrespov + @mguidon )

Ongoing

• M2 Access to log after job was run (via API) #687

Open

• M2 Query I/O Port Descriptors for Study via API #686

[pcrespov]

Update on sprint Zefram Cochrane

Ongoing

• Reviews on NIH's sparc.client repo
• Integration of osparc as O2SparcService nih-sparc/sparc.client#7
• New meeting on Tuesday, January 31, 2023 8:00 PM - 8:30 PM

[elisabettai]

@pcrespov, is there anything worth mentioning on the call on January 31?

[pcrespov]

Update on sprint Resistance Is Futile

Done

• Meeting on Tuesday, January 31, 2023 8:00 PM - 8:30 PM

Ongoing

• Reviews on NIH's sparc.client repo
• Integration of osparc as O2SparcService nih-sparc/sparc.client#7

[pcrespov]

@pcrespov, is there anything worth mentioning on the call on January 31?

@elisabettai sorry, i have just seen your message. I updated the sprint outcome

[pcrespov]

Goal for sprint Pastel de Nata

• add the python client in https://github.com/nih-sparc/sparc.client

[pcrespov]

Update for sprint Pastel de Nata

• No further progress in https://github.com/nih-sparc/sparc.client during this sprint. Will create PR in the intermezzo

[elisabettai]

@pcrespov, I've checked deadlines for this: the first task of the list "Implement base-client in nih-sparc api over osparc==0.5.0" should ideally be completed by the end of the Watermelon sprint.

I wanted to update the task list at the top, but I'm not sure if the first point depends on the second.

[bisgaard-itis]

@pcrespov, I've checked deadlines for this: the first task of the list "Implement base-client in nih-sparc api over osparc==0.5.0" should ideally be completed by the end of the Watermelon sprint.

I wanted to update the task list at the top, but I'm not sure if the first point depends on the second.

I believe this is what you suggest I work on (right @pcrespov?). Do I understand correctly from the osparc sprint board that the watermelon sprint runs until July 14?

[pcrespov]

@elisabettai yes, as I updated in the daily, this will be the case.

@bisgaard-itis , not July 7.Check the milestone deadline https://github.com/ITISFoundation/osparc-issues/milestone/46.
I will start today and if I need extra help I will ask you :-)

[bisgaard-itis]

@elisabettai yes, as I updated in the daily, this will be the case.

@bisgaard-itis , not July 7.Check the milestone deadline https://github.com/ITISFoundation/osparc-issues/milestone/46. I will start today and if I need extra help I will ask you :-)

Perfect. Thanks.
Just let me know

[pcrespov]

Update Watermelon

• Added functionality in sparc.client for basic tutorial @bisgaard-itis
• Now have concrete plan for adding more tutorials @bisgaard-itis

[bisgaard-itis]

Update Sundae

• Only missing a PR review to merge ✨ Extends o2sparc client functionality nih-sparc/sparc.client#17 which will expose all functionality from the API server necessary to run a variant of the BasicTutorial
• We have a concrete user story (Basic tutorial 2: Pseudo-code for user story involving CWL @elisabettai osparc-simcore-clients#53) for a tutorial displaying cross-functionalities between the different cores.

[bisgaard-itis]

Update Baklava

• Added a tutorial on the sparc.client repository which demonstrates the capabilities of the osparc submodule https://github.com/nih-sparc/sparc.client/blob/main/docs/tutorial-osparc.ipynb
• Added a mark down version of this tutorial to the documentation https://docs.sparc.science/docs/sparc-python-client#o%C2%B2s%C2%B2parc-module
• From what I (MB) can tell the only thing missing for this ticket is the cross-functionality tutorial (demonstrating cross-functionality between the different cores)
• Completed M1-12 Support MAP-Core for simulations on the Portal #681 with last meeting and final report with Map-core

[elisabettai]

@bisgaard-itis, this looks completed to me as far as the description/NIH is concerned.

I only see this open task:

• Upgrade version when new client (with functionality above) is released @bisgaard-itis

Do you think is still relevant?
fyi, we also have these new cases, partially related
#1088
#1095

[bisgaard-itis]

@bisgaard-itis, this looks completed to me as far as the description/NIH is concerned.

I only see this open task:

* [ ]  Upgrade version when new client (with functionality above) is released [@bisgaard-itis](https://github.com/bisgaard-itis)

Do you think is still relevant? fyi, we also have these new cases, partially related #1088 #1095

@elisabettai I think this is still relevant to the extend that when we release a new osparc python client we should ensure the sparc.client still works with the new client. Which is of course the case as long as we don't break backwards compatibility. But I am not sure how much functionality we need to expose in sparc.client. Hence, I guess we can remove that task for now

[elisabettai]

Ok. Thanks @bisgaard-itis, I leave it open for the moment while thinking where what you described should go.

Curiosity: do we already know when we want to release a new version of the Python client? I guess server side we have tons of new things already.

[bisgaard-itis]

@elisabettai We discussed several times about releasing a new python client, but I don't think we settled on a date yet. It might make sense to wait until we have sufficient study functionality for Cedric to do his work 🤔

[elisabettai]

I close this for now. It sounds that the new remaining task is release a new client with new functionality (e.g. the one for studies).

This is probably going to be needed when #767 is ready or for #1088.