9f28c7f69e700fa77ab91e4f4c3f3fe2432e4b8f lrnassar Wed Jun 25 12:58:23 2025 -0700 Beginning to phase our GBiB mentions for docker, refs #35611 diff --git src/hg/htdocs/goldenPath/help/assemblyHubGuidelines.html src/hg/htdocs/goldenPath/help/assemblyHubGuidelines.html index 7c5476c5f67..18521bfd542 100755 --- src/hg/htdocs/goldenPath/help/assemblyHubGuidelines.html +++ src/hg/htdocs/goldenPath/help/assemblyHubGuidelines.html @@ -48,31 +48,36 @@
  • Configuring Assembly Hubs to Use a Dynamic gfServer
  • Overview

    The Assembly Hub function allows you to display your novel genome sequence using the UCSC Genome Browser.

    Web Server

    -

    To display your novel genome sequence, use a web server at your institution (or free services like Cyverse), for usage behind a firewall you can also load them locally through GBiB to supply your files to the UCSC Genome Browser. Note that hosting hub files on HTTP is highly recommended and much more efficient than FTP. You then establish a hierarchy of directories and files to host your novel genome sequence. For example:

    +

    To display your novel genome sequence, use a web server at your institution (or free services +like Cyverse), +for usage behind a firewall you can also load them locally through docker +to supply your files to the UCSC Genome Browser. Note that hosting hub files on HTTP is highly +recommended and much more efficient than FTP. You then establish a hierarchy of directories and +files to host your novel genome sequence. For example:

     myHub/ - directory to organize your files on this hub
         hub.txt - primary reference text file to define the hub, refers to:
         genomes.txt - definitions for each genome assembly on this hub
             newOrg1/ - directory of files for this specific genome assembly
                 newOrg1.2bit - ‘2bit’ file constructed from your fasta sequence
                 description.html - information about this assembly for users
                 trackDb.txt - definitions for tracks on this genome assembly
                 groups.txt - definitions for track groups on this assembly
                 bigWig and bigBed files - data for tracks on this assembly
                 external track hub data tracks
     

    The URL to reference this hub would be: http://yourLab.yourInstitution.edu/myHub/hub.txt

    Note: there is now a useOneFile on hub setting that allows the hub properties to be specified in a single file. More information about this setting can be found on the Genome Browser User Guide.

    @@ -279,31 +284,32 @@

    Please see Running your own gfServer for details on installing and configuring both dedicated and dynamic gfServers.

     transBlat yourServer.yourInstitution.edu 17777
     blat yourServer.yourInstitution.edu 17779
     isPcr yourServer.yourInstitution.edu 17779
     

    Please see more about configuring your blat gfServer to replicate the UCSC Browser's settings, which will also have information about optimizing PCR results. The Source Downloads page offers access to utilities with pre-compiled binaries such as gfserver found in a blat/ directory for your machine type here and further blat documentation here, and the gfServer usage statement for further options.

    -

    Please also know you can set up gfservers on a GBiB and run it locally. Please see this GBiB assembly blat step-by-step set up page for details.

    +

    Please also know you can set up gfservers on docker and run it locally. +

    Note: You can stop your instance of gfServer with a command. For example:

     gfServer stop localhost 17860
     

    Troubleshooting BLAT servers

    You can see this error if you have the translatedBlat / nucleotideBlat port numbers the wrong way around:

     Expecting 6 words from server got 2
     

    The following is an example of an error message when attempting to run a DNA sequence query via the web-based BLAT tool after loading a hub, after starting a gfServer instance (from the same dir as the 2bit file). For example, a command to start an instance of gfServer:

     gfServer start localhost 17779 -stepSize=5 contigsRenamed.2bit &
     

    Example of a possible error message, from web-based BLAT after attempting a web-based BLAT query: