Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update HCA ontology to OLS 4 #935

Closed
2 of 5 tasks
amnonkhen opened this issue Mar 31, 2023 · 4 comments
Closed
2 of 5 tasks

update HCA ontology to OLS 4 #935

amnonkhen opened this issue Mar 31, 2023 · 4 comments
Assignees

Comments

@amnonkhen
Copy link
Contributor

amnonkhen commented Mar 31, 2023

overview
upgrade OLS to 4 on HCAO.

** Tasks **

  • get information about new version and upgrade process from ontologies team
  • upgrade locally and test
  • test upgrade on dev

Context
The gender schema PR is blocked by an ontology issue since November 2022
From release 1.0.45 a new set of terms was loaded from NCIT, under "Gender". However, our validators are not recognising any of the new terms because they are missing the "obo_id" field , which we use to query the service and verify terms are present. You can see an example api response for the imported terms here.

Zoe advised us to reached out to Henriette from the OLS team and ask for her help
From Henriette

Unfortunately I cannot help you to resolve the missing obo_id. The version of OLS you are on is incredibly old and not supported. The obo_id is available on the main OLS (https://www.ebi.ac.uk/ols/api/ontologies/hcao/terms?iri=http://purl.obolibrary.org/obo/NCIT_C17357) and on the new OLS4 (https://www.ebi.ac.uk/ols4/api/ontologies/hcao/terms/http%253A%252F%252Fpurl.obolibrary.org%252Fobo%252FNCIT_C17357) for this term.
Some suggestions as to how you can deal with this:

  1. Use OLS4 instead of your instance of OLS. This will be the recommended approach.
  2. Update the code to use either use the obo_id or the short_form (which is available based on API response)
  3. Upgrade the OLS version of your instance. This is a point we have raised a number of times with HCA in the past and the problem is that no one seems to know where this server is in order to ssh into it. Another option is to setup a completely new server with a new instance.

Actions

  • discuss priority of task
  • chose one of the suggested approaches
@Wkt8
Copy link

Wkt8 commented Apr 4, 2023

Amnon to go with path 1 (updating to OLS4) in dev.

@amnonkhen amnonkhen changed the title update ols version in hca ontology update HCA ontology to OLS 4 Apr 7, 2023
@amnonkhen
Copy link
Contributor Author

Send the ontology team a few questions about the upgrade process on the #hca-ontologies slack channel.

@amnonkhen amnonkhen self-assigned this Apr 7, 2023
@serjoshua
Copy link

Good day, Josh here from the OLS team. Thanks to Bradley, we were directed to this ticket regarding an inquiry upgrading to OLS4. I saw that Henriette already responded to a separate inquiry as well regarding an obo_id, which I concur.

Upon checking the Dockerfile you shared, there will definitely be some updates that need to be done if you are going to run OLS4 locally or on your own server. Luckily, we believe, it is easier now than ever. You can check OLS4 GitHub page regarding this matter. James made a detailed explanation how the new parts of OLS4 were implemented and how to run them using Docker. As a summary, there are four major Docker containers (excluding frontend) that will be of interest to you: dataload, solr, neo4j and backend. The dataload turns ontologies to datasets, loads them to solr and neo4j and then starts both containers on ports 8983 and 7474, respectively. The backend hosts the API above the solr and neo4j instances. To use your own ontology, you have to provide a configuration in JSON format to OLS4_CONFIG environment variable. Sample files can be found inside the dataload/configs directory of the project. Again, more detailed instructions and information are available in our GitHub page.

If you are using OLS (Production) APIs, you could easily change the URL paths from ols to ols4. OLS4 APIs are meant to be backward compatible. Any discrepancies will be considered a bug. Feel free to raise an issue in our GitHub page for any concerns regarding the use of APIs. Thanks.

@amnonkhen
Copy link
Contributor Author

amnonkhen commented Jul 10, 2023

A discussion with Enrique, James and Amnon held on 10/7/2023.
This will be handled in a new ticket #963

@amnonkhen amnonkhen reopened this Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants