From e89575c1ee083758f722fd6aad8f6a72ee6e2f24 Mon Sep 17 00:00:00 2001 From: Andres Rios Tascon Date: Mon, 21 Oct 2024 16:52:47 -0400 Subject: [PATCH] feat: added setup page --- scikit_hep_tutorial/00-bienvenida.md | 4 +- scikit_hep_tutorial/_toc.yml | 20 +++---- scikit_hep_tutorial/configuracion.md | 79 ++++++++++++++++++++++++++++ 3 files changed, 93 insertions(+), 10 deletions(-) create mode 100644 scikit_hep_tutorial/configuracion.md diff --git a/scikit_hep_tutorial/00-bienvenida.md b/scikit_hep_tutorial/00-bienvenida.md index 0371abe..2e79800 100644 --- a/scikit_hep_tutorial/00-bienvenida.md +++ b/scikit_hep_tutorial/00-bienvenida.md @@ -1,4 +1,6 @@ -# ¡Bienvenido/a! +# Tutorial de Scikit-HEP + +## ¡Bienvenido/a! Este tutorial tiene como objetivo demostrar cómo comenzar rápidamente con [Scikit-HEP](https://scikit-hep.org), una colección de paquetes para el análisis de física de partículas en Python. diff --git a/scikit_hep_tutorial/_toc.yml b/scikit_hep_tutorial/_toc.yml index 223c3e9..7915ca1 100644 --- a/scikit_hep_tutorial/_toc.yml +++ b/scikit_hep_tutorial/_toc.yml @@ -4,12 +4,14 @@ format: jb-book root: 00-bienvenida parts: -- caption: Lecciones - chapters: - - file: 01-introduccion - - file: 02-uproot - - file: 03-ttree - - file: 04-awkward - - file: 05-histogramas - - file: 06-vectores-lorentz - - file: 07-mas-herramientas + - chapters: + - file: configuracion + - caption: Lecciones + chapters: + - file: 01-introduccion + - file: 02-uproot + - file: 03-ttree + - file: 04-awkward + - file: 05-histogramas + - file: 06-vectores-lorentz + - file: 07-mas-herramientas diff --git a/scikit_hep_tutorial/configuracion.md b/scikit_hep_tutorial/configuracion.md new file mode 100644 index 0000000..8093237 --- /dev/null +++ b/scikit_hep_tutorial/configuracion.md @@ -0,0 +1,79 @@ +# Configuración + +## Para el tutorial + +Este tutorial utiliza una muestra de los paquetes del [proyecto Scikit-HEP](https://scikit-hep.org/) (Uproot, Awkward Array, hist, Vector, zfit, Particle, fastjet), que son todos componentes que podrías utilizar en tu análisis, así como Python 3, NumPy y una variedad de otras librerías populares (Pandas, Matplotlib, JupyterLab, Numba). + +En lugar de pedirte que los instales todos, ofrecemos dos formas diferentes de ejecutar todo en tu navegador: GitHub Codespaces y Binder. +Recomendamos que uses GitHub Codespaces (lee las instrucciones a continuación). Si esta opción no es viable para ti, puedes usar Binder, aunque ten en cuenta que los recursos podrían ser muy limitados. + +### GitHub Codespaces + + + +Para usar GitHub Codespaces, necesitas crear una cuenta en [GitHub](https://github.com/) (¡es gratis! También puedes unirte a su programa educativo para obtener más beneficios gratuitos). + +Haz clic en el siguiente botón (se abrirá una nueva página), luego vuelve a estas instrucciones: + +

+ + Iniciar GitHub Codespaces + +

+ +Después de iniciar el codespace de GitHub, observa las líneas en la pestaña "Terminal" a continuación. Puede tomar un tiempo hasta que el entorno se configure por completo. Si ves líneas como estas: + +``` +Use Cmd/Ctrl + Shift + P -> View Creation Log to see full logs +✔ Finishing up... +✔ Running updateContentCommand... +⠦ Running postCreateCommand... + › python3 -m pip install -r requirements.txt +``` + +la instalación sigue en progreso. + +Una vez que hayas terminado, deberías ver solo un prompt vacío como este: + +``` +@klieret ➜ /workspaces/hsf-training-scikit-hep-webpage (main) $ +``` + +Espera unos segundos para asegurarte de que no se ejecute nada más. + +Ahora mira el panel lateral izquierdo. Deberías ver un archivo llamado `notebook.ipynb`. Haz clic en él. +Se abrirá una nueva pestaña con el notebook. + +```{admonition} Nota +Si el notebook no aparece después de varios minutos (y solo ves la "barra de progreso azul" en la parte superior), +podrías intentar usar un navegador diferente. Ha habido informes de que esto ocurre con +Safari en macOS y con ventanas privadas de Firefox. +``` + +Intenta ejecutar la primera línea para verificar que todo esté configurado correctamente. + +¡Estás listo para comenzar 🎉! + +### Binder + +Simplemente haz clic en el siguiente botón: + +

+ + Iniciar Binder + +

+ +## Después del tutorial + +Si deseas instalar algunos de estos paquetes en tu propio computador o en el de tu laboratorio, te recomiendo [Miniforge](https://github.com/conda-forge/miniforge) (o Anaconda/Miniconda con el canal [conda-forge](https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge)). Este método también proporciona una manera de [instalar ROOT en el mismo entorno](https://github.com/conda-forge/root-feedstock#readme). Para configurar el entorno utiliza el archivo [environment.yml](https://github.com/hsf-training/hsf-training-scikit-hep-webpage/blob/main/environment.yml) (junto con su archivo [requirements.txt](https://github.com/hsf-training/hsf-training-scikit-hep-webpage/blob/main/requirements.txt)) en la [base](https://github.com/hsf-training/hsf-training-scikit-hep-webpage) de este repositorio, como: + +```bash +conda install uproot awkward # ... ¿otros? +``` + +Alternativamente, puedes instalar todos los paquetes requeridos localmente con pip: consulta el archivo environment.yml y el archivo requirements.txt para una lista (esto incluye todas las dependencias bajo la clave pip y algunas de las dependencias mencionadas anteriormente).