beedeem
  • Introduction
  • Installation
    • Requirements
    • Directory structure
    • Installation
    • Quick start guide
      • Install a bank
      • Query the bank repository
      • Run a BLAST search
      • Annotate a BLAST result
  • BeeDeeM reference manual
    • BeeDeeM configuration
    • Databank descriptors
    • Install databanks
    • Databanks management
    • Descriptors format
    • Advanced uses
    • Filter sequences
    • Appendix - Regular expressions
    • Appendix - Installation errors and solutions
    • Appendix - Advanced configuration
  • Use BeeDeeM from a graphical interface
    • Overview
    • Install banks
    • Add a new bank descriptor
    • Delete your banks
  • BeeDeeM extended FASTA format
  • Utility tools
    • Query databank repository
    • Annotate BLAST results
    • List installed banks
  • Run BLAST search
Powered by GitBook
On this page
  1. Installation

Directory structure

PreviousRequirementsNextInstallation

Last updated 2 years ago

Was this helpful?

CtrlK

Was this helpful?

Basically, BeeDeeM expects to access two directories for processing banks installation at runtime:

  • a working directory (workingDir): to create log files, temporary files, etc.

  • a bank home directory (biobaseRootDir): the place where all banks are installed. Inside that directory, BeeDeeM creates and manages sub-directories... you are invited to avoid editing manually that structure!

Note: when using the legacy or Conda installer, there is a third directory, refer to as installDir, where BeeDeeM software has been installed. More on this in the next section.

Of course, BeeDeeM requires read/write permissions on workingDir and biobaseRootDir directories.

When using the legacy installer, workingDir and biobaseRootDir are set at installation time.

When using either Docker, Singularity or Conda installation mode, workingDir and biobaseRootDir are set at runtime using KL_WORKING_DIR and KL_mirror__path environment variables, respectively (variable names are case sensitive and there are indeed two underscore characters between "mirror" and "path", this is NOT a typo; more on this later).