Skip to content

Answer the question "How do I get X software onto Cheaha?" #1041

@wwarriner

Description

@wwarriner

What would you like to see added?

We have a good overview of some software basics, but the pieces are scattered and disconnected. The most frequent question is "How do I get X software on Cheaha?"

Let's write an article that describes how to answer that question. There are different paths to take depending on the software availability, installation method, license, and terms of use.

  • First check to see if we already have it as a pre-installed module or an interactive app.
    • Be sure our installed version is up-to-date! If we have the software, but an older version, please contact us.
  • Security, legal, or regulatory requirements (CUI, FISMA, USA FedGov Clearance, ITAR, etc.)
    • Contact us
  • License that costs money
    • Approval by Ent IT software governance
  • License or Terms that restrict who can use the software
    • Approval by Ent IT software governance
    • License hosting?
    • Linux-based access controls to the software files and directory
  • License or Terms requiring positive confirmation through action (signing, clicking an "I accept" button, checking a "I have read the terms" box, etc.)
    • UAB Employees are NOT permitted to agree to restrictive licenses or terms unilaterally without approval!
    • Check if an alternative license or terms are available for installation on a shared environment. We can facilitate this discovery.
    • If not...
    • Approval by Ent IT software governance
    • Each researcher may need to install the software separately in their own personal or group environments, and restrict access by others.
    • The "signer" is responsible for ensuring access is controlled
  • Available on a package/environment manager?
    • Use the package manager to create an environment and install it there
      • Use git + github/gitlab for version control of the environment definition
    • Common package/environment managers
      • conda-forge (Python mostly, and some notable others)
      • node and npm (JavaScript) (can be obtained on conda-forge)
      • maven and gradle (Java) (can be obtained on conda-forge)
      • CRAN and Renv package (R) (Renv can be obtained on conda-forge, but if you do, you need to get the full stack of R and packages from conda-forge as well! Mixing R and conda-forge can be challenging, but is more reproducible than just RStudio)
      • Pkg.jl (Julia) (Julia can be obtained on conda-forge, and pkg.jl through Julia)
      • Matlab (this is a module)
  • Can be self-installed with a binary file or script?
    • Install into /home/$USER/bin/ or wherever the instructions indicate.
    • Installer cannot use sudo or installation will fail
    • Installer cannot put files into OS directories and must be installed in your home directory or a project directory (for shared installs in your group)
  • Can be built from source?
    • If you have the skills and knowledge, please feel free to do so.
    • If not, please contact us.
  • None of the above?
    • Check our pre-installed modules and interactive apps!
    • If it is not available at all, please contact us.

Metadata

Metadata

Assignees

Labels

style: tutorial 📚📝Tutorials, use cases and how-to guidessystem: cheaha 🖧Docs related to Cheaha platformsystem: software 💻Related to finding, installing, maintaining software and licenses

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions