Readme changes

parent 1c32c514
......@@ -19,17 +19,17 @@ This program is a degree audit system for degrees at The University of Texas at
2. License
The Graduation Audit System is distributed under GNU Public License Version 3.
The Graduation Audit System is distributed under the GNU Public License Version 3.
3. Contents
bs/ -degree plans for Bachelor of Sciences degrees
ba/ -degree plans for Bachelor of Arts degrees
transcripts/ -CSV files that contain the students information
transcripts/ -Some example transcripts in the specified .csv format
README -this README file
counting.lp -file that has rules for counting hours
course.lp -file that contains every class in the system
COPYING -GNU GPLv3
COPYING -License
main.lp -file that is run by s(ASP)
main_writer.py -Python script that generates main.lp
req_writer.py -Python script that generates req.lp file
......@@ -47,15 +47,15 @@ Ghostscript is required to run extract.py.
Example degree plans and transcripts are included in the bs/, ba/, and transcripts/ folders.
To run an audit, you must use main_writer.py and pass in a CSV file to create a main.lp file which will be executed by s(ASP). Run this command in the terminal:
To run an audit, you must use main_writer.py and pass in a transcript file to create a main.lp file which will be executed by s(ASP). Run this command in the terminal:
python main_writer.py test.csv
python main_writer.py <transcript.csv>
This will look for the test.csv file in the transcripts folder and update the main.lp file in the main directory. This main.lp file contains information from the transcript in the form of logic facts. Once the main.lp file is created/updated, run this command in the terminal:
This will use test.csv to build main.lp, which can in turn be executed by s(ASP). Once the main.lp file is created run this command in the terminal:
sasp main.lp
This will run the audit for the transcript created by main_writer.py and will determine if the student can graduate and if not, what classes are needed.
This will run the audit and provide appropriate advising information.
6. Creating/Modifying Degree Plans
......@@ -67,7 +67,7 @@ B. Next, create a "req" lp file with the naming convention:
"<acronym><year>req.lp"
For example, for the CS 2015 degree plan, the file would be called: cs2015.req.
For example, for the CS 2015 degree plan, the file would be called: cs2015req.lp.
C. Now, create logic rules in the form of:
......@@ -79,13 +79,13 @@ typeOfRequirement is what type of requirement the class will fulfill.
Note: If the class is absolutely required to graduate, its typeOfRequirement is "required". Otherwise, it is whatever requirement you want to name it.
Example: hist1301 is an American history class that counts toward the American History Requirement in the degree plan and it is NOT absolutely required to graduate.
Example: hist1301 is an American history class that counts toward the American History Requirement in the degree plan and it is not absolutely required to graduate (another American History course can be used to satisfy the requirement).
Add: _req(hist1301,americanHist). where americanHist is the typeOfRequirement.
Add: _req(hist1301,americanHist).
Another example: govt2305 is a government class that IS required to graduate.
Another example: govt2305 is a government class that is required to graduate.
Add: _req(govt2305,required). where required is the typeOfRequirement.
Add: _req(govt2305,required).
For every class that could be used for a particular type of requirement in the degree plan, add a _req() rule.
These rules are used to associate classes with requirements and used for counting.
......@@ -95,7 +95,7 @@ Once the req file is complete, make sure the naming convention is correct and pl
i.e. For the B.S. Computer Science degree plan of 2015, place the req file in gradaudit/bs/cs/2015. This directory will eventually contain 5 LP files all associated with this exact degree plan.
Note: A course should not satisfy more than one degree requirement.
i.e. there should not be the two facts '_req(course1,req1)' and '_req(course2,req2)' for any degree.
i.e. there should not be the two facts '_req(course1,req1)' and '_req(course1,req2)' for any degree.
D. Once the _req file has been created, run the python script req_writer.py and pass three arguments in the command line in this form:
......@@ -208,7 +208,3 @@ _meetsElectiveHours(Student,Min).
_auditElectiveHours(Student,Min).
This rule is the same as auditHours except the requirement is for electives. Similar to auditHours, it will always be true.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment