Updated Home (markdown)

Godwin Ani 2025-03-03 11:41:24 -05:00
parent b57394bb83
commit 05de73abaf

23
Home.md

@ -7,6 +7,29 @@ We also provide a suite of utility scripts for describing data output by EukPhyl
Note that EukPhylo used to go by the name of "PhyloToL," hence some residual instances where we refer to "PTL1" and "PTL2" instead of "EukPhylo part 1" and "EukPhylo part 2" respectively (for instance, in the Github folder structure).
> Note: The EukPhylo pipeline is currently being dockerised for easier installation and use. More information about the dockerfile can be found here - [Docker branch](https://github.com/Katzlab/EukPhylo/tree/Docker)
## Dockerfile
The [docker file](https://github.com/Katzlab/EukPhylo/blob/Docker/PTL2/Dockerfile) can be executed with:
```bash
cd EukPhylo
# Build the container
docker build -t Dockerfile . --tag MyEuk:1
# Get the container IMAGE_ID
docker image list
# Current command is:
docker run -it \
--mount type=bind,src=$(pwd)/databases,dst=/Databases \
--mount type=bind,src=$(pwd)/input_data,dst=/Input_data \
--mount type=bind,src=$(pwd)/output_data,dst=/Output_data \
{IMAGE_ID}
```
After development, GitHub CICD workflows can be added to automatically build and release the dockerfile for the end user.
## EukPhylo Part 1 Gene family assignment
* [Overview and modularity](https://github.com/Katzlab/EukPhylo/wiki/EukPhylo-part-1:-gf-assignment#overview-and-modularity)