Merrypopins Streamlit App

📦 Run Merrypopins Streamlit App

Merrypopins includes an interactive Streamlit app for visualizing and detecting pop-ins in indentation data. This app allows you to upload your data files, run the detection algorithms, and visualize the results in a user-friendly interface.

🌐 Try It Online

🚀 Live demo: explore Merrypopins in your browser!

🐳 Using Docker

You can run the interactive Streamlit app for visualizing and detecting pop-ins directly using Docker.

🔧 Option 1: Build and Run Locally

# Clone the repo if not already
git clone https://github.com/SerpRateAI/merrypopins.git
cd merrypopins

# Build the Docker image
docker build -t merrypopins-app .

# Run the app on http://localhost:8501
docker run -p 8501:8501 merrypopins-app

🌐 Option 2: Pull and Run Pre-built Image from Docker Hub (Recommended Takes Less Time)

# Pull the latest pre-built image from Docker Hub
docker pull cacarvuai/merrypopins-app:latest

# Run the container
docker run -p 8501:8501 cacarvuai/merrypopins-app:latest

🌟 Access the App

Once the app is running, you can access it in your web browser at http://localhost:8501.

🧼 Clean Up

To stop the app, press Ctrl+C (on Windows/Linux) or ⌘(Command)+C (on MacOS) in the terminal where it's running.

If you want to remove the Docker container, you can run:

docker rm -f $(docker ps -aq --filter "ancestor=cacarvuai/merrypopins-app:latest")

If you built the image locally, you can remove it with:

docker rmi merrypopins-app

Running the App Locally Without Docker

If you prefer to run the Streamlit app without Docker, you can do so by following these steps:

1. Install the required dependencies for the app:

   pip install -r streamlit_app/requirements.txt
   

2. Run the Streamlit app:

   streamlit run streamlit_app/app.py
   

3. Open your web browser and go to http://localhost:8501 to access the app.

Publishing New App Versions to Docker Hub (Only for Maintainers)

To publish a new version of the Merrypopins Streamlit app, follow these steps:

1. Update the version date in streamlit_app/app.py.
2. Commit your changes to the Git repository.
3. Push the changes to the remote repository.
4. Build and push the updated Docker image to Docker Hub:

   docker login
   docker buildx build \
    --platform linux/amd64,linux/arm64 \
    -t cacarvuai/merrypopins-app:latest \
    --push .
   

5. Update the documentation to reflect the new version.

Note: If you are not a maintainer, please do not attempt to publish new versions. Instead, you can contribute by submitting issues or pull requests with improvements or bug fixes. If you want to create your own version of the app, you can fork the repository and modify the code as needed. Just remember to change the Docker image name to avoid conflicts with the official version. e.g docker build -t yourdockerhubusername/merrypopins-app:latest .