Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 3.29 KB

README.md

File metadata and controls

41 lines (31 loc) · 3.29 KB
Raw

License: GPL v3 Build Status Coverage Status DOI

CurricularAnalytics.jl

CurricularAnalytics.jl is a toolbox for studying and analyzing academic program curricula. The toolbox represents curricula as graphs, allowing various graph-theoretic measures to be applied in order to quantify the complexity of curricula. In addition to analyzing curricular complexity, the toolbox supports the ability to visualize curricula, to compare and contrast curricula, to create optimal degree plans for completing curricula that satisfy particular constraints, and to simulate the impact of various events on student progression through a curriculum.

Documentation

Full documentation is available at GitHub Pages. Documentation for functions in this toolbox is also available via the Julia REPL help system. Additional tutorials can be found at the Curricular Analytics Notebooks site.

Installation

Installation is straightforward. First, install the Julia programming language on your computer. To do this, download Julia here: https://julialang.org, and follow the instructions for your operating system.

Next, open the Julia application that you just installed. It should look similar to the image below. This interface is referred to as the Julia REPL.

Julia termain

Next, enter Pkg mode from within Julia by hitting the ] key, and then type:

  pkg> add CurricularAnalytics

This will install the toolbox, along with the other Julia packages needed to run it. To load and use the toolbox, hit the backspace key to return to the Julia REPL. Now type:

  julia> using CurricularAnalytics

The toolbox must be loaded again via using CurricularAnalytics every time you restart Julia.

For more information about installing the toolbox, including the steps neccessary to utilize degree plan optimization, please see the INSTALLING.md

Supported Versions

  • CurricularAnalytics master will be maintained/enhanced to work with the latest stable version of Julia.
  • Julia 1.0.5, 1.2, 1.3, 1.4: CurricularAnalytics v1.0.0 is the latest version guaranteed to work with Julia 1.0.5 to version 1.4.
  • Later versions: Some functionality might not work with prerelease / unstable / nightly versions of Julia. If you run into a problem, please file an issue.

Contributing and Reporting Bugs

We welcome contributions and bug reports! Please see CONTRIBUTING.md for guidance on development and bug reporting.