Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.22 KB

readme.md

File metadata and controls

57 lines (41 loc) · 2.22 KB
Raw

https://wolfr.am/wss2018github

This is a sample student repository for the Wolfram Summer School 2018. You can clone or fork this repository to get started

Thing to do to get started with GIT:

Create a GitHub account

https://github.com/join

Create a new repo

you can either create a new repo or fork this one

Give your instructor write permissions

you need to give write permission to that repo to your tutor and to @WolframSummerSchoolProjects. Additionally please give write permissions to @abritac and @swedewhite for organizational purposes (you can revoke these at the end of school).

Download and install a Git UI

On OSX / Wndows:
Download and install github desktop:
https://desktop.github.com

On Ubuntu:
Download and install git kraken:
https://www.gitkraken.com
Login and authenticate with GitHub
https://support.gitkraken.com/integrations/github

Install command line utility (optional)

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Clone the repo locally

by clicking on the button CLONE OR DOWNLOAD and then to OPEN IN DESKTOP

StudentDeliverables folder

this contains templates for various notebooks you will be creating and submitting during the course of the school, according to the deadlines mentioned in the syllabus.

Write a readme using MarkDown

a nice cheatsheet can be found here: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet the readme should contain:

  1. what your project is about
  2. how to run your code
  3. examples, code documentation, etc

Organize your code

in this repository you will find 2 different ways to organize your code, the simple way and the programmer way.

The simple way

you split your logic into functions that you need for your projects and notebooks that you use to visualize data and show final results.

  1. the code is in starthere/simple.m
  2. the notebook used for visualization is in starthere/simple.nb

The programmer way

I prepared a very simple project paclet you can use, it provides a way to organize your code and your data

  1. the code is in paclet in starthere/Project folder
  2. raw source data can be put in starthere/Project/Assets/ folder
  3. the notebook used for visualization is in starthere/advanced.nb