The steps below are generalized and might need adjustments based on the actual requirements of Fishgrs or similar tools.
To avoid errors during installation, ensure your system meets the following requirements:
| Component | Minimum Requirement | Recommended | | :--- | :--- | :--- | | OS | Ubuntu 20.04 / macOS Big Sur | Ubuntu 22.04 LTS or Windows WSL2 | | RAM | 4 GB | 16 GB | | Storage | 10 GB free | 50 GB (for reference genomes) | | Internet | Broadband (for downloading dependencies) | Fiber optic | fishgrs install
Note for Windows Users: FishGRS does not run natively on Windows command prompt. You must use Windows Subsystem for Linux (WSL2) with Ubuntu 22.04.
fishgrs plot --input results/grs_output.txt --histogram The steps below are generalized and might need
If you see a histogram pop up (or saved as grs_distribution.png), you have mastered the fishgrs install process.
fishgrs config --init
This creates ~/.fishgrs/config.yaml. Edit it with your preferred text editor: fishgrs plot --input results/grs_output
reference_genome: "/path/to/ref/salmo_salar.fa"
plink_executable: "/home/user/miniconda3/envs/fishgrs_env/bin/plink"
output_directory: "/home/user/fishgrs_results"
docker run --rm -it fishgrs/fishgrs:latest fishgrs --help
With Docker, the fishgrs install process is essentially instantaneous because you are downloading a pre-built image.
| Step | Action |
|------|--------|
| 1️⃣ | Resolves package name to source (registry/git) |
| 2️⃣ | Clones/downloads into ~/.local/share/fishgrs/ |
| 3️⃣ | Adds to fishfile (dependency lock) |
| 4️⃣ | Symlinks or sources plugin files |
| 5️⃣ | Runs post-install hooks (if any) |