Enhanced installation guide #306
Conversation
|
I've added the following description.
|
README.md
Outdated
| @@ -93,6 +93,11 @@ location. | |||
| # Installation | |||
|
|
|||
| ## Installing with pip | |||
| Check out the Mac setup guide for vrs-python [here](https://github.com/ga4gh/vrs-python/blob/main/docs/setup_help/m1_mac_setup.md). This is a crucial step before diving into UTA. Once you've completed the setup, proceed with configuring the PostgreSQL database for the Unified Transcriptome Annotation (UTA) application [here](https://github.com/ga4gh/vrs-python/blob/main/docs/setup_help/uta_installation.md). | |||
There was a problem hiding this comment.
I'm sorry. I messed up here. I forgot that VRS-Python uses docker containers to run. We should note that this is only for local install of UTA, which stands for Universal Transcript Archive
README.md
Outdated
| @@ -93,6 +93,11 @@ location. | |||
| # Installation | |||
|
|
|||
| ## Installing with pip | |||
| Check out the Mac setup guide for vrs-python [here](https://github.com/ga4gh/vrs-python/blob/main/docs/setup_help/m1_mac_setup.md). This is a crucial step before diving into UTA. Once you've completed the setup, proceed with configuring the PostgreSQL database for the Unified Transcriptome Annotation (UTA) application [here](https://github.com/ga4gh/vrs-python/blob/main/docs/setup_help/uta_installation.md). | |||
|
|
|||
| Before installing the `ga4gh.vrs[extras]` package, ensure that **PostgreSQL** is installed on your system. You can download and install PostgreSQL from [here](https://www.postgresql.org/download/). | |||
There was a problem hiding this comment.
Should we also include installation via homebrew?
Not sure which version we want to maintain:
brew formulae | grep postgresql@
There was a problem hiding this comment.
I guess the m1_mac_setup.md has the brew instructions
I don't see this instruction there:
brew formulae | grep postgresql@
It's still not clear to me how to address the installation instructions of UTA based on the provided info because while running containers there is a uta container running , also the official guide (of UTA) has the information about the docker container as well as the local setup.
There was a problem hiding this comment.
Right the command was just listing possible versions. I am not sure which ones out of these we should maintain. But I think homebrew could be given as another option in the repo readme.
We can ignore my other comment about the other docs and address in a separate issue.
There was a problem hiding this comment.
So how should we proceed with homebrew and should we keep the dedicated uta instruction or just link it to the official uta guide ?
There was a problem hiding this comment.
Let's stick with your original commit (sorry) and we can make a new issues (if they do not already exist):
- Add information on which versions are supported / option to install via homebrew
- Reference setup help docs in readme
There was a problem hiding this comment.
No problem I'll make the changes soon.
Thanks and Happy New Year 🎉💯
There was a problem hiding this comment.
If any additional information is required or any omissions are necessary, please feel free to let me know .
|
Added additional details for Homebrew installation and linked the documentation. There is a Minor formatting error which has also been addressed in this commit. |
There was a problem hiding this comment.
This looks great. Thank you. @korikuzma this seems to satisfy your last change request. I'm going to approve and merge. Let me know if you have any issues, if so, I'll back out the changes or we can start a new issue to reconcile.
* Enhanced installation guide * Added MacSetup and Postgres for UTA. * Added Homebrew installation guide and referenced documentation
Fixes : #144
Previously, the installation guide lacked clear instructions for installing
PostgreSQL, which is a prerequisite for the project setup.The installation guide has been revised to explicitly include instructions for the prerequisite, addressing the requirements.