Installation

⚙️ Installation

🐳 Docker Installation (Recommended)

To install and set up the Streamlit app using Docker, follow these steps:

Step 1

Pull the Docker image from GitHub Container Registry:

   docker pull ghcr.io/bioshape-lab/cells:main

Step 2

Run the Docker image:

   docker run --name streamlit -p 8501:8501 --rm  ghcr.io/bioshape-lab/cells:main

The Streamlit app should now be running locally. Open your web browser and visit http://localhost:8501 to access the app.

🐍 Local Installation

To install and set up the Streamlit app, follow these steps:

Step 1

Clone the repository:

gh repo clone bioshape-lab/cells

Step 2

Navigate to the project directory:

cd cells/cells/streamlit

Step 3

Create a virtual environment (optional but recommended):

python -m venv env

Step 4

Activate the virtual environment:

  • For Windows:

    .\env\Scripts\activate
  • For macOS and Linux:

    source env/bin/activate

Step 5

Install project dependencies using Poetry:

poetry install

This command reads the pyproject.toml file, resolves dependencies, and installs them into the virtual environment.

Step 6

Run the Streamlit app:

streamlit run Hello.py

The Streamlit app should now be running locally. Open your web browser and visit http://localhost:8501 to access the app.