Skip to content

Commit

Permalink
feat: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ariostas committed Oct 21, 2024
0 parents commit 32159b2
Show file tree
Hide file tree
Showing 39 changed files with 24,998 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
60 changes: 60 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Build and Deploy Book

on:
workflow_dispatch:
pull_request:
push:
branches:
- main

env:
BASE_URL: /${{ github.event.repository.name }}

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build-book:
name: Build Book
runs-on: ubuntu-latest
timeout-minutes: 30
# Required for miniconda to activate conda
defaults:
run:
shell: bash -l {0}
steps:
- name: Check out repo
uses: actions/checkout@v4
- name: Get conda
uses: conda-incubator/setup-miniconda@v3
with:
auto-update-conda: true
python-version: "3.12"
miniforge-version: latest
use-mamba: true
environment-file: environment.yml
activate-environment: skhep-tutorial
- name: Build the book
run: |
jupyter-book build scikit_hep_tutorial
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "scikit_hep_tutorial/_build/html"

deploy-book:
name: Deploy Book
runs-on: ubuntu-latest
needs: build-book
if: github.event_name == 'push'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
_build
.ipynb_*
*.root

.DS_Store

29 changes: 29 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
ci:
autoupdate_schedule: monthly

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-added-large-files
- id: check-case-conflict
- id: check-merge-conflict
- id: check-symlinks
- id: debug-statements
- id: end-of-file-fixer
files: ^(_episodes|README.md|setup.md)
- id: mixed-line-ending
- id: trailing-whitespace
files: ^(_episodes|code|README.md|setup.md)

- repo: https://github.com/asottile/blacken-docs
rev: 1.19.0
hooks:
- id: blacken-docs
additional_dependencies: [black==22.6.0]
files: '.*\.md'

- repo: https://github.com/kynan/nbstripout
rev: 0.7.1
hooks:
- id: nbstripout
84 changes: 84 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Código de Conducta convenido para Contribuyentes

## Nuestro compromiso

Nosotros, como miembros, contribuyentes y administradores nos comprometemos a hacer de la participación en nuestra comunidad sea una experiencia libre de acoso para todo el mundo, independientemente de la edad, dimensión corporal, discapacidad visible o invisible, etnicidad, características sexuales, identidad y expresión de género, nivel de experiencia, educación, nivel socio-económico, nacionalidad, apariencia personal, raza, casta, color, religión, o identidad u orientación sexual.

Nos comprometemos a actuar e interactuar de maneras que contribuyan a una comunidad abierta, acogedora, diversa, inclusiva y sana.

## Nuestros estándares

Ejemplos de comportamientos que contribuyen a crear un ambiente positivo para nuestra comunidad:

* Demostrar empatía y amabilidad ante otras personas
* Respeto a diferentes opiniones, puntos de vista y experiencias
* Dar y aceptar adecuadamente retroalimentación constructiva
* Aceptar la responsabilidad y disculparse ante quienes se vean afectados por nuestros errores, aprendiendo de la experiencia
* Centrarse en lo que sea mejor no sólo para nosotros como individuos, sino para la comunidad en general

Ejemplos de comportamiento inaceptable:

* El uso de lenguaje o imágenes sexualizadas, y aproximaciones o
atenciones sexuales de cualquier tipo
* Comentarios despectivos (_trolling_), insultantes o derogatorios, y ataques personales o políticos
* El acoso en público o privado
* Publicar información privada de otras personas, tales como direcciones físicas o de correo
electrónico, sin su permiso explícito
* Otras conductas que puedan ser razonablemente consideradas como inapropiadas en un
entorno profesional

## Aplicación de las responsabilidades

Los administradores de la comunidad son responsables de aclarar y hacer cumplir nuestros estándares de comportamiento aceptable y tomarán acciones apropiadas y correctivas de forma justa en respuesta a cualquier comportamiento que consideren inapropiado, amenazante, ofensivo o dañino.

Los administradores de la comunidad tendrán el derecho y la responsabilidad de eliminar, editar o rechazar comentarios, _commits_, código, ediciones de páginas de wiki, _issues_ y otras contribuciones que no se alineen con este Código de Conducta, y comunicarán las razones para sus decisiones de moderación cuando sea apropiado.

## Alcance

Este código de conducta aplica tanto a espacios del proyecto como a espacios públicos donde un individuo esté en representación del proyecto o comunidad. Ejemplos de esto incluyen el uso de la cuenta oficial de correo electrónico, publicaciones a través de las redes sociales oficiales, o presentaciones con personas designadas en eventos en línea o no.

## Aplicación

Instancias de comportamiento abusivo, acosador o inaceptable de otro modo podrán ser reportadas a los administradores de la comunidad responsables del cumplimiento a través de [INSERTAR MÉTODO DE CONTACTO]. Todas las quejas serán evaluadas e investigadas de una manera puntual y justa.

Todos los administradores de la comunidad están obligados a respetar la privacidad y la seguridad de quienes reporten incidentes.

## Guías de Aplicación

Los administradores de la comunidad seguirán estas Guías de Impacto en la Comunidad para determinar las consecuencias de cualquier acción que juzguen como un incumplimiento de este Código de Conducta:

### 1. Corrección

**Impacto en la Comunidad**: El uso de lenguaje inapropiado u otro comportamiento considerado no profesional o no acogedor en la comunidad.

**Consecuencia**: Un aviso escrito y privado por parte de los administradores de la comunidad, proporcionando claridad alrededor de la naturaleza de este incumplimiento y una explicación de por qué el comportamiento es inaceptable. Una disculpa pública podría ser solicitada.

### 2. Aviso

**Impacto en la Comunidad**: Un incumplimiento causado por un único incidente o por una cadena de acciones.

**Consecuencia**: Un aviso con consecuencias por comportamiento prolongado. No se interactúa con las personas involucradas, incluyendo interacción no solicitada con quienes se encuentran aplicando el Código de Conducta, por un periodo especificado de tiempo. Esto incluye evitar las interacciones en espacios de la comunidad, así como a través de canales externos como las redes sociales. Incumplir estos términos puede conducir a una expulsión temporal o permanente.

### 3. Expulsión temporal

**Impacto en la Comunidad**: Una serie de incumplimientos de los estándares de la comunidad, incluyendo comportamiento inapropiado continuo.

**Consecuencia**: Una expulsión temporal de cualquier forma de interacción o comunicación pública con la comunidad durante un intervalo de tiempo especificado. No se permite interactuar de manera pública o privada con las personas involucradas, incluyendo interacciones no solicitadas con quienes se encuentran aplicando el Código de Conducta, durante este periodo. Incumplir estos términos puede conducir a una expulsión permanente.

### 4. Expulsión permanente

**Impacto en la Comunidad**: Demostrar un patrón sistemático de incumplimientos de los estándares de la comunidad, incluyendo conductas inapropiadas prolongadas en el tiempo, acoso de individuos, o agresiones o menosprecio a grupos de individuos.

**Consecuencia**: Una expulsión permanente de cualquier tipo de interacción pública con la comunidad del proyecto.

## Atribución

Este Código de Conducta es una adaptación del [Contributor Covenant][homepage], versión 2.1,
disponible en https://www.contributor-covenant.org/es/version/2/1/code_of_conduct.html

Las Guías de Impacto en la Comunidad están inspiradas en la [escalera de aplicación del código de conducta de Mozilla](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

Para respuestas a las preguntas frecuentes de este código de conducta, consulta las FAQ en
https://www.contributor-covenant.org/faq. Hay traducciones disponibles en https://www.contributor-covenant.org/translations
105 changes: 105 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Contribuyendo

[HSF training][hsf-training] es un proyecto de código abierto,
y damos la bienvenida a contribuciones de todo tipo:
nuevas lecciones,
correcciones de material existente,
informes de errores,
y revisiones de los cambios propuestos, todos son bienvenidos.

## Acuerdo de Contribución

Al contribuir,
aceptas que podemos redistribuir tu trabajo bajo [nuestra licencia](LICENSE.md).
A cambio,
abordaremos tus problemas y/o evaluaremos tu propuesta de cambio lo más pronto posible,
y te ayudaremos a convertirte en miembro de nuestra comunidad.
Todos los involucrados en [HSF training][hsf-training]
aceptan cumplir con nuestro [código de conducta](CODE_OF_CONDUCT.md).

## Cómo Contribuir

La forma más sencilla de empezar es presentar un "issue"
para informarnos sobre un error,
una redacción incómoda,
o un error factual.
Esta es una buena manera de presentarte
y conocer a algunos de los miembros de nuestra comunidad.

1. Si no tienes una cuenta en [GitHub][github],
puedes escribir un correo electrónico a los coordinadores.
Sin embargo,
podremos responder más rápidamente si utilizas uno de los métodos descritos a continuación.

2. Si tienes una cuenta en [GitHub][github],
o estás dispuesto a [crear una][github-join],
pero no sabes cómo usar Git,
puedes reportar problemas o sugerir mejoras [creando un issue][issues].
Esto nos permite asignar el elemento a alguien
y responder a él en una discusión encadenada.

3. Si te sientes cómodo con Git,
y te gustaría agregar o cambiar material,
puedes enviar un "pull request" (PR).
Las instrucciones para hacerlo están [incluidas a continuación](#using-github).

## Qué Contribuir

Hay muchas formas de contribuir,
desde escribir nuevos ejercicios y mejorar los existentes,
hasta actualizar o completar la documentación
y enviar [informes de errores][issues]
sobre cosas que no funcionan, no están claras o están ausentes.
Si buscas ideas, consulta la pestaña 'Issues' para ver
una lista de problemas asociados a este repositorio,
o también puedes revisar todos los problemas en [hsf-training][hsf-training-issues].

También hay [una lista](hsf-training-gfis) de todos los problemas que son particularmente fáciles y adecuados
para las primeras contribuciones.

Los comentarios sobre issues y las revisiones de pull requests son igualmente bienvenidos:
somos más inteligentes juntos que por separado.
Las revisiones de principiantes y recién llegados son especialmente valiosas:
es fácil para quienes han estado utilizando estas lecciones durante un tiempo
olvidar lo impenetrable que puede ser parte de este material,
por lo que siempre se agradecen ojos nuevos.

## Usando GitHub

Si decides contribuir a través de GitHub, es posible que desees consultar
[Cómo Contribuir a un Proyecto de Código Abierto en GitHub][how-contribute].
Para gestionar cambios, seguimos [el flujo de GitHub][github-flow].
Cada lección tiene dos mantenedores que revisan problemas y pull requests o animan a otros a hacerlo.
Los mantenedores son voluntarios de la comunidad y tienen la última palabra sobre lo que se fusiona en la lección.
Para usar la interfaz web para contribuir a una lección:

1. Haz un fork del repositorio original a tu perfil de GitHub.
2. Dentro de tu versión del repositorio forked, muévete a la rama `main` y
crea una nueva rama para cada cambio significativo que se realice.
3. Navega a los archivos que deseas cambiar dentro de las nuevas ramas y realiza las revisiones necesarias.
4. Confirma todos los archivos cambiados dentro de las ramas correspondientes.
5. Crea pull requests individuales desde cada una de tus ramas modificadas
a la rama `main` dentro del repositorio original.
6. Si recibes comentarios, realiza cambios utilizando tus ramas específicas del problema del repositorio forked y
los pull requests se actualizarán automáticamente.
7. Repite según sea necesario hasta que se haya abordado todo el feedback.

Al comenzar a trabajar, asegúrate de que tu clon de la rama `main` original esté actualizado
antes de crear tus propias ramas específicas de revisión a partir de allí.
Además, por favor, trabaja solo desde tus ramas recién creadas y *no*
desde tu clon de la rama `main` original.
Por último, las copias publicadas de todas las lecciones están disponibles en la rama `main` del repositorio original para referencia mientras revisas.

## Otros Recursos

Más información sobre cómo contribuir o cómo contactarnos: [Inicio de HSF training][hsf-training]

[hsf-training-issues]: https://github.com/issues?q=user%3Ahsf-training+is%3Aopen
[hsf-training]: https://hepsoftwarefoundation.org/workinggroups/training.html
[email]: mailto:https://groups.google.com/forum/#!forum/hsf-training-wg
[github]: https://github.com
[github-flow]: https://guides.github.com/introduction/flow/
[github-join]: https://github.com/join
[how-contribute]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
[issues]: https://guides.github.com/features/issues/
[hsf-training-gfis]: https://github.com/issues?q=is%3Aissue+is%3Aopen+archived%3Afalse+sort%3Aupdated-desc+label%3A%22good+first+issue%22+org%3Ahsf-training
Loading

0 comments on commit 32159b2

Please sign in to comment.