Skip to content

raymond-u/noah-cli

Repository files navigation

Noah

Noah is a project management tool specifically designed for bioinformatics projects. It enables reproducible analysis of large datasets, making it effortless to share and collaborate with others.

PyPI version Anaconda-Server Badge image License: MIT

Features

  • A human-readable configuration file
  • Git integration
  • Guaranteed reproducibility and portability
  • Managing data, containers, and workflows, all in one place

Installation

The easiest way to install Noah is to use pip:

pip install noah-cli

Quickstart

To get started with Noah, use the noah init command to create a new project:

noah init my_project # This will by default create a Git repository
cd my_project

To add a new dataset to your project, use the noah add command:

noah add SRP123456 # ENCSR123ABC, GSE123456, etc. are also supported

You can also add privately hosted datasets:

noah add me@some_host:path/to/my_dataset ftp://ftp.example.com/another_dataset

If you share your project with others, they can easily retrieve the datasets you added:

noah install

For more information, please refer to examples.

License

This project is licensed under the MIT license. See LICENSE for details.

About

a project management tool for reproducible, portable, and streamlined bioinformatics analysis

Resources

License

Stars

Watchers

Forks

Languages