Commit 04e18c3b authored by Alexander Martinez's avatar Alexander Martinez
Browse files

plantilla cursos 21B

parents
# License for LA-CoNGA Physics Contents
All content generated within the framework of the LA-CoNGA Physics project will be covered under open licenses.
Multimedia contents (Images, Videos and Audio), collections (Text documents, Presentations and PDF's) and datasets will have the Creative Commons Attribution 4.0 license (CC-By-4.0). The computer codes, markup languages and in general, all software will have a GPL V3 license. For more information on this vocabulary visit [Dublin core specifications](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/dcmitype/Collection)
The license text listed below (describing CC-BY-4.0 as their usage in LA-CoNGA Physics) is re-used under a CC-BY license from The Turing Way wich is also re-used from the Carpentries community materials.
(Specifically from the [Reproducible Science Curriculum](https://github.com/Reproducible-Science-Curriculum/sharing-RR-Jupyter/blob/gh-pages/LICENSE.md)).
> The contents used in LA-CoNGA Physics activities created by other projects or institutions will retain the rights assigned by their creators. The contents derived from these will respect the rights of use of the original contents.
## Process Documents and Data
All Collection, Dataset, Interactive Resource, Event, Images Moving Image, Sound and and Text in this repository are made available under the [Creative Commons Attribution license][cc-by-human].
The following is a human-readable summary of (and not a substitute for) the [full legal text of the CC BY 4.0 license][cc-by-legal].
You are free:
* to **Share**---copy and redistribute the material in any medium or format
* to **Adapt**---remix, transform, and build upon the material
for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:
* **Attribution**---You must give appropriate credit (mentioning that your work is derived from work that is Copyright ©LA-CoNGA Physics and, where practical, linking to [https://laconga.redclara.net](https://laconga.redclara.net)), provide a [link to the license][cc-by-human], and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* **No additional restrictions**---You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
With the understanding that:
* You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
* No warranties are given. The license may not give you all of the permissions necessary for your intended use.
For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
## Software
> Except where otherwise noted, the software and infrastructure provided by LA-CoNGA Physics Community are made available under the [OSI][osi]-approved [GPL-V3][GPL-V3].
All software in this repository are made available under the [GNU General Public License V3][GPL-V3].
The following is a summary of (and not a substitute for) the [full legal text of the GNU General Public License V3][GPL-V3].
### GNU General Public V3 License Summary
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to **freedom**, not price. Our General Public Licenses are designed to make sure that you have the freedom to **distribute** copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can **change** the software or use pieces of it in new free programs, and that you know you can do these things.
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
[GPL-V3]: https://www.gnu.org/licenses/gpl-3.0.en.html
[osi]: https://opensource.org
[![pipeline status](https://gitmilab.redclara.net/tutoriales/tutorial-mkdocs/badges/master/pipeline.svg)](https://gitmilab.redclara.net/tutoriales/tutorial-mkdocs/-/commits/master)
#Bienvenidos!
# URL de los cursos de LA-CoNGA physics
[https://laconga.redclara.net/courses/index.html](https://laconga.redclara.net/courses/index.html)
---
# Utilizando MkDocs en tu propio computador
## Requirement:
### MkDocs:
### Get it in https://www.mkdocs.org/
* Follow the instructions below in section **Building your project documentation**
### **For Latex-kind and Maths**
* ```python-markdown-math```
Get it (install using ```pip```) as mentioned in: https://github.com/mitya57/python-markdown-math
---
**Once you get those installed**:
You can follow this instruction:
``` shell
git clone https://gitmilab.redclara.net/tutoriales/tutorial-mkdocs.git
cd tutorial-mkdocs
mkdocs serve
```
To put it in App, you need to generate HTML by:
```
mkdocs build
```
---
# Building your project documentation
[**MkDocs**](https://www.mkdocs.org) is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
Documentation source files are written in **Markdown**, and configured with a single YAML configuration file.
## **Mkdocs installation**
* **Prerequisite: Python and Pip**
In order to manually install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have these already installed from the command line:
**On Windows:**
```
C:\Users\User>python --version
Python 3.5.4
C:\Users\User>pip --version
pip 9.0.1
```
**On MacOS or Linux**
```
$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2
```
* **Installing Python**
Install [Python](https://www.python.org/) by downloading an installer appropriate for your system from [python.org](https://www.python.org/downloads/) and running it.
**Note:**
If you are installing Python on Windows, be sure to check the box to have Python added to your PATH if the installer offers such an option (it's normally off by default).
![path](https://www.mkdocs.org/img/win-py-install.png)
* **Installing Pip**
If you're using a recent version of Python, the Python package manager, pip, is most likely installed by default. However, you may need to upgrade pip to the lasted version:
`pip install --upgrade pip`
If you need to install pip for the first time, download get-pip.py. Then run the following command to install it:
`python get-pip.py`
* **Installing MkDocs**
Install the `mkdocs` package using pip:
```
pip install mkdocs
```
You should now have the `mkdocs` command installed on your system. Run `mkdocs--version` to check whether successfully installed.
**On Windows:**
```
C:\Users\User>mkdocs --version
mkdocs, version 1.0.4
```
**On MacOS or Linux**
```
$ mkdocs --version
mkdocs, version 0.15.3
```
## **Getting started to edit**
* Clone this documentation to your device by git
Clone with https:
```
git clone git clone https://github.com/LA-CoNGA-MiLab-RedClara/tutorial-mkdocs.git
cd tutorial-mkdocs
```
In your `docs` folder, you will see a configuration file named `mkdocs.yml`, and a folder named `docs` that will contain your documentation source files.
![folder1](https://github.com/veritasalice/MarkdownPhotos/blob/master/folder1.png?raw=true)
Right now the `docs` folder just contains all the documentation pages, such as `index.md`, `datasets.md` and the folders where the pages are saved.
![folder2](https://github.com/veritasalice/MarkdownPhotos/blob/master/folder2.png?raw=true)
MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. Make sure you're in the same directory as the `mkdocs.yml` configuration file, and then start the server by running the `mkdocs serve` command:
```
C:\Users\User\tutorial-mkdocs>mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 190705 15:13:53 server:296] Serving on http://127.0.0.1:8000
[I 190705 15:13:53 handlers:62] Start watching changes
[I 190705 15:13:53 handlers:64] Start detecting changes
```
Open up `http://127.0.0.1:8000/` in your browser, and you'll see the pages you cloned being displayed:
![pic3](https://gitmilab.redclara.net/tutoriales/tutorial-mkdocs/blob/master/docs/images/la-conga.png?raw=true)
Use the editor you like to edit the files in `docs` and your changes will be displayed when saving them.
## **Using the Git to commit your changes**
By far, the most widely used modern version control system in the world today is Git.
In Git, every developer's working copy of the code is also a repository that can contain the full history of all changes.
**Prerequisites:**
* [Download](https://git-scm.com/downloads) and install Git
* [Apply for a Gitlab account](https://gitlab.cern.ch/)
**The working flow of Git:**
* Initialise your repository with `git init[directory]`
* Clone a repository onto your local machine with `git clone [URL]`
* Edit the docs using Mkdocs
* Stage all changes for the next conmmit with `git add [directory]`
* Commit the staged snapshot with `git commit -m ["commit message"]`
* If others have modified it, you can **check the updates** with `git fetch` and **update the resource** with `git pull`.
* Show unstaged changes between your index and working directory with `git diff`
* Review your changes before submitting with `git status`
* Push your changes to the remote Gitlab repository with `git push`
![gitFlow](https://i.stack.imgur.com/ODFYa.png)
Reference to [git cheat sheet](file:///C:/Users/User/Downloads/atlassian-git-cheatsheet.pdf) for details
---
# Astropartículas y Cosmología
El objetivo de este curso es ...
Los cursos para el módulo de *Astropartículas y Cosmología* avanzada son:
- [Curso 1](#curso-1)
- [Curso 2](#curso-2)
## Curso 1
### Temáticas
* Temática 1
* Temática 2
### Acompañamiento Docente
Este módulo contará con la orientación de:
+ [nombre](http://laconga.redclara.net/link-laconga-net), Institución.
Acompañados de un equipo de consultoría:
+ [nombre](http://laconga.redclara.net/link-laconga-net), Institución.
### Pre-requisites/Co-requisites
* Requisito 1
Remedial tutorials will be offered to students who are not Physics majors.
### Calendario
Check academic calendar [here](../intro/CalendarioCursos21B.md)
### Estructura de la clases
* Each session is a self-contained module
* A set of questions, videos, exercises and reading are proposed at the end of each session for individual work
### Evaluaciones
Students are expected to submit 8 written homeworks. This corresponds to 100% of the total grade.
### Programa y objetivos de aprendizaje semanales
#### Senana 1 (# hours): Tema (I)
* objetivo de aprendizaje 1
#### Apendices (TBD): Tema
* objetivo de aprendizaje 1
### Materiales para el curso
#### Lecturas requeridas
* Lectura 1
* Lectura 2
---
## Curso 2
### Temáticas
* Temática 1
* Temática 2
### Acompañamiento Docente
Este módulo contará con la orientación de:
+ [nombre](http://laconga.redclara.net/link-laconga-net), Institución.
Acompañados de un equipo de consultoría:
+ [nombre](http://laconga.redclara.net/link-laconga-net), Institución.
### Pre-requisites/Co-requisites
* Requisito 1
Remedial tutorials will be offered to students who are not Physics majors.
### Calendario
Check academic calendar [here](../intro/CalendarioCursos21B.md)
### Estructura de la clases
* Each session is a self-contained module
* A set of questions, videos, exercises and reading are proposed at the end of each session for individual work
### Evaluaciones
Students are expected to submit 8 written homeworks. This corresponds to 100% of the total grade.
### Programa y objetivos de aprendizaje semanales
#### Senana 1 (# hours): Tema (I)
* objetivo de aprendizaje 1
#### Apendices (TBD): Tema
* objetivo de aprendizaje 1
### Materiales para el curso
#### Lecturas requeridas
* Lectura 1
* Lectura 2
---
# Clase ## - Nombre de la clase - (Fecha)
## Objetivos de la clase.
Especificar los objetivos de la clase, qué se busca, qué se va a presentar:
- Objetivo 1.
- Objetivo 2.
- ...
## Actividades Antes de la Clase
Es deseable especificar las actividades previas que debieran cumplir los estudiantes. Qué leer, qué estudiar, qué revisar/calcular.
- Actividad 1.
- Actividad 2.
- ...
## Materiales de apoyo
Especificar los materiales de apoyo (artículos, videos, códigos), tanto aquéllos que se deben revisar antes de clase, como los que sean el resultado de las clase.
- Material 1.
- Material 2.
- ...
### Presentación
<!--
Pdf de ejemplo. para agregar el pdf de su clase modifique los siguientes parámetros con la ruta al documento pdf:
- data="ruta/PDF"
- src="ruta/PDF"
- href="ruta/PDF"
-->
<object data="materiales/presentacion.pdf" type="application/pdf" width="700px" height="700px">
<embed src="materiales/presentacion.pdf">
<p>Su navegador no soporta la visualización de documentos PDF. Por favor descargue el documento: <a href="materiales/presentacion.pdf">Descargar PDF</a>.</p>
</embed>
</object>
### Video
<!--
Video de ejemplo. ver la guía markdown para ver cómo agregar el video de clase desde Youtube en https://laconga.redclara.net/courses/tools/markdown.html#incluir-videos-desde-youtube
-->
<iframe width="560" height="315" src="https://www.youtube.com/embed/L_UnB1rvoLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Al finalizar estos contenidos
En esta sección se deben especificar los resultados que los docentes esperan de la clase. Una lista que le sirva de autoevaluación a los estudiantes para saber si están en sintonía con lo que espera el docente.
- Resultado 1.
- Resultado 2.
- Resultado 3.
> Puede encontrar una guía para escritura en formato *MarkDown* en [Guía MarkDown](../../tools/markdown.md)
# Clase ## - Nombre de la clase - (Fecha)
## Objetivos de la clase.
Especificar los objetivos de la clase, qué se busca, qué se va a presentar:
- Objetivo 1.
- Objetivo 2.
- ...
## Actividades Antes de la Clase
Es deseable especificar las actividades previas que debieran cumplir los estudiantes. Qué leer, qué estudiar, qué revisar/calcular.
- Actividad 1.
- Actividad 2.
- ...
## Materiales de apoyo
Especificar los materiales de apoyo (artículos, videos, códigos), tanto aquéllos que se deben revisar antes de clase, como los que sean el resultado de las clase.
- Material 1.
- Material 2.
- ...
### Presentación
<!--
Pdf de ejemplo. para agregar el pdf de su clase modifique los siguientes parámetros con la ruta al documento pdf:
- data="ruta/PDF"
- src="ruta/PDF"
- href="ruta/PDF"
-->
<object data="materiales/presentacion.pdf" type="application/pdf" width="700px" height="700px">
<embed src="materiales/presentacion.pdf">
<p>Su navegador no soporta la visualización de documentos PDF. Por favor descargue el documento: <a href="materiales/presentacion.pdf">Descargar PDF</a>.</p>
</embed>
</object>
### Video
<!--
Video de ejemplo. ver la guía markdown para ver cómo agregar el video de clase desde Youtube en https://laconga.redclara.net/courses/tools/markdown.html#incluir-videos-desde-youtube
-->
<iframe width="560" height="315" src="https://www.youtube.com/embed/L_UnB1rvoLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Al finalizar estos contenidos
En esta sección se deben especificar los resultados que los docentes esperan de la clase. Una lista que le sirva de autoevaluación a los estudiantes para saber si están en sintonía con lo que espera el docente.
- Resultado 1.
- Resultado 2.
- Resultado 3.
> Puede encontrar una guía para escritura en formato *MarkDown* en [Guía MarkDown](../../tools/markdown.md)
# Clase ## - Nombre de la clase - (Fecha)
## Objetivos de la clase.
Especificar los objetivos de la clase, qué se busca, qué se va a presentar:
- Objetivo 1.
- Objetivo 2.
- ...
## Actividades Antes de la Clase
Es deseable especificar las actividades previas que debieran cumplir los estudiantes. Qué leer, qué estudiar, qué revisar/calcular.
- Actividad 1.
- Actividad 2.
- ...
## Materiales de apoyo
Especificar los materiales de apoyo (artículos, videos, códigos), tanto aquéllos que se deben revisar antes de clase, como los que sean el resultado de las clase.
- Material 1.
- Material 2.
- ...
### Presentación
<!--
Pdf de ejemplo. para agregar el pdf de su clase modifique los siguientes parámetros con la ruta al documento pdf:
- data="ruta/PDF"
- src="ruta/PDF"
- href="ruta/PDF"
-->
<object data="materiales/presentacion.pdf" type="application/pdf" width="700px" height="700px">
<embed src="materiales/presentacion.pdf">
<p>Su navegador no soporta la visualización de documentos PDF. Por favor descargue el documento: <a href="materiales/presentacion.pdf">Descargar PDF</a>.</p>
</embed>
</object>
### Video
<!--
Video de ejemplo. ver la guía markdown para ver cómo agregar el video de clase desde Youtube en https://laconga.redclara.net/courses/tools/markdown.html#incluir-videos-desde-youtube
-->
<iframe width="560" height="315" src="https://www.youtube.com/embed/L_UnB1rvoLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Al finalizar estos contenidos
En esta sección se deben especificar los resultados que los docentes esperan de la clase. Una lista que le sirva de autoevaluación a los estudiantes para saber si están en sintonía con lo que espera el docente.
- Resultado 1.
- Resultado 2.
- Resultado 3.
> Puede encontrar una guía para escritura en formato *MarkDown* en [Guía MarkDown](../../tools/markdown.md)
# Clase ## - Nombre de la clase - (Fecha)
## Objetivos de la clase.
Especificar los objetivos de la clase, qué se busca, qué se va a presentar:
- Objetivo 1.
- Objetivo 2.
- ...
## Actividades Antes de la Clase
Es deseable especificar las actividades previas que debieran cumplir los estudiantes. Qué leer, qué estudiar, qué revisar/calcular.
- Actividad 1.
- Actividad 2.
- ...
## Materiales de apoyo
Especificar los materiales de apoyo (artículos, videos, códigos), tanto aquéllos que se deben revisar antes de clase, como los que sean el resultado de las clase.
- Material 1.
- Material 2.
- ...
### Presentación
<!--
Pdf de ejemplo. para agregar el pdf de su clase modifique los siguientes parámetros con la ruta al documento pdf:
- data="ruta/PDF"
- src="ruta/PDF"
- href="ruta/PDF"
-->
<object data="materiales/presentacion.pdf" type="application/pdf" width="700px" height="700px">
<embed src="materiales/presentacion.pdf">
<p>Su navegador no soporta la visualización de documentos PDF. Por favor descargue el documento: <a href="materiales/presentacion.pdf">Descargar PDF</a>.</p>
</embed>
</object>
### Video
<!--
Video de ejemplo. ver la guía markdown para ver cómo agregar el video de clase desde Youtube en https://laconga.redclara.net/courses/tools/markdown.html#incluir-videos-desde-youtube
-->
<iframe width="560" height="315" src="https://www.youtube.com/embed/L_UnB1rvoLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Al finalizar estos contenidos
En esta sección se deben especificar los resultados que los docentes esperan de la clase. Una lista que le sirva de autoevaluación a los estudiantes para saber si están en sintonía con lo que espera el docente.
- Resultado 1.
- Resultado 2.
- Resultado 3.
> Puede encontrar una guía para escritura en formato *MarkDown* en [Guía MarkDown](../../tools/markdown.md)
# Clase ## - Nombre de la clase - (Fecha)
## Objetivos de la clase.
Especificar los objetivos de la clase, qué se busca, qué se va a presentar:
- Objetivo 1.
- Objetivo 2.
- ...
## Actividades Antes de la Clase
Es deseable especificar las actividades previas que debieran cumplir los estudiantes. Qué leer, qué estudiar, qué revisar/calcular.
- Actividad 1.
- Actividad 2.
- ...
## Materiales de apoyo
Especificar los materiales de apoyo (artículos, videos, códigos), tanto aquéllos que se deben revisar antes de clase, como los que sean el resultado de las clase.
- Material 1.
- Material 2.
- ...
### Presentación
<!--