Skip to content

README.md

Latest commit

 

History

History
126 lines (85 loc) · 5.12 KB

README.md

File metadata and controls

126 lines (85 loc) · 5.12 KB
Raw

⚛️ El Físico Remoto (Physics on Autopilot)

GitHub Actions | Quarto Publish GitHub Pages Status Licencia: MIT

Retador: Arturo Sánchez | Hackers: Equipo Análisis de Gatos

🌟 Resumen del Proyecto: Ciencia Transparente y Automatizada

Este proyecto implementa un pipeline CI/CD (Integración y Despliegue Continuo) para el análisis de datos abiertos del experimento ATLAS (CERN), utilizando Python, marimo y Quarto.

El objetivo es lograr la máxima reproducibilidad y transparencia científica. Cada git push a la rama principal desencadena una GitHub Action que ejecuta el siguiente flujo:

  1. Configura el entorno Python y Quarto.
  2. Instala las dependencias de física (uproot, awkward-array, etc.).
  3. Ejecuta el análisis físico con Python y marimo.
  4. Compila el sitio web profesional con Quarto (quarto render).
  5. Publica el sitio web completo en GitHub Pages.

🔗 Resultados en Vivo

El informe y los gráficos interactivos generados por la última ejecución automatizada (CI) están disponibles públicamente:

➡️ Ver el Sitio Web Publicado (Actualizado Automáticamente)

⚙️ Tecnologías y Características Clave

Característica Herramientas Propósito en el Reto
Análisis Físico Python, uproot, awkward-array, hist Lectura eficiente del formato ROOT y cálculo de masas invariantes.
Interactividad marimo Permite construir celdas reactivas y widgets para un análisis dinámico en la web.
Documentación Quarto Generación del sitio web profesional y la integración del contenido dinámico de marimo.
Automatización (CI/CD) GitHub Actions Orquestación del flujo completo: análisis, renderizado y despliegue continuo.

📁 Estructura del Repositorio


.
├── .github/workflows/
│   └── publish-site.yml       \# Workflow de CI/CD (GitHub Action).
├── robot-physicist-website/ \# Directorio raíz del proyecto Quarto.
│   ├── \_extensions/marimo-team/marimo \# Extensión para ejecutar marimo.
│         └──_extension.yml
│         └──command.py
│         └──extract.py
│         └──marimo-execute.lua
│         └──utils.lua
│   ├── charts/                       \# Sub-páginas de análisis.
│      └──marimotest copy/
│         └──index.qmd
│      └──marimotest
│         └──index.qmd/
│      └──index.qmd.
│   ├── .gitignore
│   ├── _quarto.yml
│   ├── about.qmd
│   ├── index.qmd         \# Página principal.
│   └── styles.css
├── .gitignore 
├── requirements.txt           \# Lista de dependencias de Python.
├── LICENSE
└── README.md

💻 Desarrollo Local

Para desarrollar el análisis y previsualizar el sitio web en tu máquina local:

1. Requisitos Previos

  1. Instalar Python (3.9+).

  2. Instalar Quarto: Sigue las instrucciones oficiales de instalación.

    ➡️ https://quarto.org/docs/get-started/

2. Configuración y Ejecución

  1. Instalar Dependencias de Python: Desde la raíz del repositorio, instala las bibliotecas de física y marimo.

    pip install -r requirements.txt

  2. Navegar a la Carpeta del Sitio Web:

    cd robot-physicist-website

  3. Ejecutar Vista Previa (Modo Desarrollo): Quarto abrirá el sitio en tu navegador y lo actualizará automáticamente con cada cambio.

    quarto preview

🤖 Automatización y CI/CD (GitHub Actions)

El archivo .github/workflows/publish-site.yml maneja la automatización completa:

  • Flujo: push ➡️ Configuración del entorno ➡️ Instalación de uproot/marimo ➡️ quarto render (ejecuta el análisis) ➡️ Despliegue a GitHub Pages.

Este pipeline garantiza que el sitio web refleje siempre el resultado más reciente y reproducible de tu análisis científico.

📚 Recursos y Licencia

Este repositorio está publicado bajo la licencia MIT. Consulta el archivo ./LICENSE para detalles completos.