deploy: a903678

LinkedEarth · Sep 8, 2023 · 7c74901 · 7c74901
commit 7c74901
Show file tree

Hide file tree

Showing 152 changed files with 8,720 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a290ddf1df70aeb0601e021c043d2674
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/credit.doctree b/.doctrees/credit.doctree
diff --git a/.doctrees/dependencies.doctree b/.doctrees/dependencies.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/exercises.doctree b/.doctrees/exercises.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/purpose.doctree b/.doctrees/purpose.doctree
diff --git a/.doctrees/usage.doctree b/.doctrees/usage.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/credit.rst b/_sources/credit.rst
@@ -0,0 +1,7 @@
+
+
+Credit and inspiration
+======================
+
+Inspired by and derived from https://hpc-carpentry.github.io/hpc-python/
+which is distributed under CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
diff --git a/_sources/dependencies.rst b/_sources/dependencies.rst
@@ -0,0 +1,17 @@
+
+
+Dependencies
+============
+
+Required
+--------
+
+- Python
+- Numpy
+- Matplotlib
+
+
+Optional
+--------
+
+- Docker
diff --git a/_sources/exercises.rst b/_sources/exercises.rst
@@ -0,0 +1,49 @@
+
+
+Exercises (documentation lesson)
+================================
+
+Before you start
+----------------
+
+- Discuss the exercise idea with the classroom.
+- Distribute exercises among groups of 2-3 persons.
+- Open a GitHub issue and inform the community about the problem and how you
+  plan to solve it. Discuss why we do this.
+- Fork this project.
+- Commit to your fork. In your commit message auto-close the issue you have addressed.
+- Submit a pull request.
+- We then review the pull requests.
+- After the pull requests are merged we verify that documentation updates itself.
+
+
+Basic
+-----
+
+- Document the purpose of this example code.
+- Document how to clone the code.
+- Describe the project tree structure.
+- Write a sentence or two about Zipf's law and link to Wikipedia
+  (coordinate with the group working on the previous exercise).
+- Document how to check the code style with ``pycodestyle``.
+- Give other developers hints on how they can contribute to the documentation.
+- Document how to build the documentation locally
+  (coordinate with the group working on the previous exercise).
+- Add an example output.
+- Add an example plot
+  (coordinate with the group working on the previous exercise).
+- Document where/how to ask for help.
+- Add a math equation somewhere.
+
+
+Advanced
+--------
+
+- Add a test and document how to run it.
+- Add the possibility to auto-document Python code.
+
+
+Meta
+----
+
+- Add new exercises ideas for future workshops (edit this file).
diff --git a/_sources/index.rst b/_sources/index.rst
@@ -0,0 +1,17 @@
+.. this is a comment, it is not rendered
+   when adding new *.rst files, reference them here
+   in this index.rst for them to be rendered and added to the
+   table of contents
+
+
+Basics
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   purpose.rst
+   dependencies.rst
+   usage.rst
+   credit.rst
+   exercises.rst
diff --git a/_sources/purpose.rst b/_sources/purpose.rst
@@ -0,0 +1,12 @@
+
+
+Purpose
+=======
+
+Write me ...
+
+
+Basics
+----------
+
+Write me ...
diff --git a/_sources/usage.rst b/_sources/usage.rst
@@ -0,0 +1,17 @@
+
+
+Usage
+=====
+
+
+How to clone the code
+---------------------
+
+Write me ...
+
+
+
+Where to find the results
+-------------------------
+
+Write me ...