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

PR for: Docs: Installation instructions #232

Closed
wants to merge 0 commits into from

Conversation

joeflack4
Copy link
Contributor

@joeflack4 joeflack4 commented Aug 25, 2022

Updates

Added installation instructions, including additional steps for `SqlImplementation`

Addresses: #233

@joeflack4 joeflack4 mentioned this pull request Aug 25, 2022
3 tasks
README.md Outdated
### SqlImplementation requirements
If using `SqlImplementation`, some additional steps beyond _general purpose installation_ are required.
1. Install [`sqlite`](https://www.sqlite.org/download.html)
2. Install [`relation-graph`](https://github.com/balhoff/relation-graph#installation)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md Outdated
If using `SqlImplementation`, some additional steps beyond _general purpose installation_ are required.
1. Install [`sqlite`](https://www.sqlite.org/download.html)
2. Install [`relation-graph`](https://github.com/balhoff/relation-graph#installation)
4. Install [`rdftab`](https://github.com/ontodev/rdftab.rs#installation)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depends on: ontodev/rdftab.rs#22

Copy link
Collaborator

@cmungall cmungall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! We can include the base installation instructions

For the sqlite part: Let's not duplicate this documentation everywhere

remember, you don't need relation-graph or even sqlite to use SqlImplementation.

the complicated install of relation-graph and rdftab is only required for compiling a sqlite from owl source.

99% of OAK users won't need this, they will be using a pre-generated sqlites e.g. via sqlite:obo:mondo, and for this an pure python install from PyPI is sufficient.

and even for the smaller group who need to do the compliation, the complicated steps will disappear soon: INCATools/semantic-sql#41

the appropriate place for the granular description is in this tutorial - can you give this a read over and make any PRs there?

https://incatools.github.io/ontology-access-kit/intro/tutorial07.html

@joeflack4
Copy link
Contributor Author

@cmungall Thanks for looking this over.

Done on the new PR: #242

I must say, I don't enjoy .rst outside of the usefulness of toc tree.

Also, just made some edits to this PR to remove the SqlImplementation part of the installation, if you want to re-open and merge this one. I know it's pretty obvious, but I like to leave things simple for Jr devs who may not have Python experience.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants