scpo-compecon / coursematch.jl

CourseMatch

This is the repo for the CourseMatch term project of our course.

Checklist

• implement a Student struct to carry all relevant information
• implement student's demand function: given prices, preferences and constraints, which is the optimal choice of courses
• test demand function
• translate pseudo code of main price search algo from paper (algo 1)
• test pseudo code translation
• implement algo 2: refinement of price vector
• implement neighboring price vector function
• test neighboring price vector function

Modus Operandi

• Please never push anything onto the master branch.
• Please always submit a pull request instead.

So:

1. step one should be for everyone to fork this repo to your github account. This will create a new repo on your account at https://github.com/YOUR_GITHUB_USER/CourseMatch.jl.git. Notice that you have to replace YOUR_GITHUB_USER with your github username
2. step two should be for everyone to get the code from their fork into their computer to start developing it. type ] to activate your package manager. then:

   # you typed ]
   dev https://github.com/YOUR_GITHUB_USER/CourseMatch.jl.git   

   This will clone this repository to your computer at location ~/.julia/dev/CourseMatch. Remember that your ~/.julia can be seen by typing DEPOT_PATH[1] into your REPL.
3. You can now use the code in the package. In particular your should do in your REPL

   ]   # turn on Pkg mode
   activate CourseMatch   # activate pkg manager for this project
   instantiate   # download all required packages
   precompile    # precompile all
   test          # run the test suite of CourseMatch
   activate      # go back to main env (notice no arg given!)

4. If that works, exit pkg mode by hitting Ctrl-c. Let's see if the package also works in the main environment now.
5. Type using CourseMatch in the julia REPL (no longer in Pkg mode!)
6. Type CourseMatch.VERSION. you should see the current version.

How to Make Changes and Contribute

1. Change the code on your computer in ~/.julia/dev/CourseMatch in your text editor / juno.
2. Notice that if you set up Revise.jl in your startup.jl file as demonstrated, you can change the code in your editor, and your REPL will immediately reflect those changes (no manual reloading of the module needed!)
3. Once you are happy with your work, create a new git branch in the ~/.julia/dev/CourseMatch folder. This is a live git repo.
4. For example

   # you have made changes to the code in your text editor.
   cd ~/.julia/dev/CourseMatch
   git branch my_new_feature     # create a new branch
   git checkout my_new_feature   # checkout this branch
   git add .    # this would add everything in current dir to your commit. alternatively give file names/paths
   git commit -m 'I added a new feature'  # commit to your branch
   git push origin my_new_feature   # push your work to your fork on github

5. Finally, go to your fork at https://github.com/YOUR_GITHUB_USER/CourseMatch.jl and click on "new pull request" to create a new pull request (PR) on the origin repo. This PR will contain the changes from your branch my_new_feature

How to Update your Fork with Current Master?

• You should make your contributions always on top of the most recent master branch.
• You want to syncronize your fork with what is going on upstream, i.e. the original master branch.
• Here is how to set this up.
• You will place your new stuff on top of the most recent master branch version on a repo we'll call upstream:
  1. add the upstream repo as a remote: git remote add upstream [email protected]:ScPo-CompEcon/CourseMatch.jl.git
  2. Use the rebase command

  git checkout master  # make sure you are on your fork's master branch
  git fetch upstream   # get stuff from `upstream`
  git rebase upstream/master  # merge upstream master and put your local commits on top of it
  

  1. Then continue as above in point 4. i.e. make your changes, create a new branch, and push that to your fork.

Style Guide

1. Indent by 4 whitespaces
2. DOCUMENT EACH FUNCTION like here: https://docs.julialang.org/en/v1/manual/documentation/

coursematch.jl's Issues

improve `pseudocode`

• improve this function
• it should not include any files directly (that should be done in the package root src/CourseMatch.jl)
• improve documentation of that function by referrign to the wiki

demand function is not working

this call is outdated

https://github.com/ScPo-CompEcon/CourseMatch.jl/blob/master/src/demand.jl#L117

update to new API. you need to do ] up in teh coursematch project

read up on wiki

• read through what your predecessor have done in their work
• i transferred their wiki over to this new repo - it refers back to their issues, so it's useful for you to look at those and see the problems were at the time.

fix clearing function

this needs to be cleaned up and put in a proper unit test in the /test/ dir of the repo

make decrease_demand work

function decrease_demand needs to be fixed.

change `C` for `ncon` or something in Constraints type

fix code in neighbor_fun.jl

1. rename neighb_fun(price::Vector, demand, clear_error, pref, budget, capacity, ind_max::Int=40) to something that makes more sense. I don't want to see fun in the name of a function. describe what the function does!
2. Core function in that file is decrease_demand. This should be built with calls to demand.
3. hence, this issue depends on #1