Skip to content

Constellab/gws_ubiome

Repository files navigation

Constellab Logo


👋 Welcome to GWS Ubiome

gws_ubiome is a Constellab library (called bricks) developped by Gencovery. GWS stands for Gencovery Web Services.

🚀 What is Constellab?

Gencovery is a software company that offers Constellab., the leading open and secure digital infrastructure designed to consolidate data and unlock its full potential in the life sciences industry. Gencovery's mission is to provide universal access to data to enhance people's health and well-being.

🌍 With our Fair Open Access offer, you can use Constellab for free. Sign up here. Find more information about the Open Access offer here (link to be defined).

✅ Features

The uBiome Brick is a compact, user-friendly device designed for efficient microbiome and metagenomic data analysis. It streamlines the collection process, providing high-quality data acquisition and rapid insights into microbial communities. Ideal for research and clinical applications, the uBiome Brick offers a robust, scalable solution for advancing microbiome science.

  • Efficient Sampling: Simplifies microbiome sample collection for accurate and reliable data.
  • High-Quality Analysis: Enables detailed metagenomic analysis for comprehensive microbial insights.
  • User-Friendly: Easy to use, making it accessible for both researchers and clinicians.
  • Scalable Solution: Suitable for small-scale studies and large-scale research projects.

Explore how the uBiome Brick can enhance your microbiome research and clinical applications.

📄 Documentation

📄 For gws_ubiome brick documentation, click here

💫 For Constellab application documentation, click here

🛠️ Installation

The gws_ubiome brick requires the gws_core and gws_omix bricks.

🔥 Recommended Method

The best way to install a brick is through the Constellab platform. With our Fair Open Access offer, you get a free cloud data lab where you can install bricks directly. Sign up here

Learn about the data lab here : Overview and Data lab management

🔧 Manual installation

This section is for users who want to install the brick manually. It can also be used to install the brick manually in the Constellab Codelab.

We recommend installing using Ubuntu 22.04 with python 3.10.

Usage

▶️ To start the server :

python3 manage.py --runserver

🕵️ To run a given unit test

python3 manage.py --test [TEST_FILE_NAME]

Replace [TEST_FILE_NAME] with the name of the test file (without .py) in the tests folder.

🕵️ To run the whole test suite, use the following command:

python3 manage.py --test all

📌 VSCode users can use the predefined run configuration in .vscode/launch.json.

🤗 Community

🌍 Join the Constellab community here to share and explore stories, code snippets and bricks with other users.

🚩 Feel free to open an issue if you have any question or suggestion.

☎️ If you have any questions or suggestions, please feel free to contact us through our website: Constellab.

🌎 License

gws_ubiome is completely free and open-source and licensed under the GNU General Public License v3.0.


This brick is maintained with ❤️ by Gencovery.

Gencovery Logo