Open Problem Library

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
(Contributing to the OPL)
(Browsing the OPL)
 
(12 intermediate revisions by 4 users not shown)
Line 7: Line 7:
 
-->
 
-->
  
The WeBWorK Open Problem Library (OPL) contains problems contributed by faculty from many institutions that have used WeBWorK.  Currently, there are approximately 25,000 problems in the OPL, and new problems are added regularly.  The OPL was initially formed from several of the original [[Problem Libraries|File Based Problem Libraries]], and includes all of the problems from the Arizona State, Rochester, California State-Long Beach, and the University of Virginia libraries.  It also contains most, if not all, of the problems from Union College, the College of New Jersey, Dartmouth, Ohio State, Northern Arizona University, and Indiana University.  Once known as the National Problem Library (NPL), the Open Problem Library (OPL) naming convention was adopted in the summer of 2012 to accommodate the increasing internationalization of WeBWorK and the possible inclusion of problem libraries from textbook publishers.
+
The WeBWorK Open Problem Library (OPL) contains problems contributed by faculty from many institutions that have used WeBWorK.  Currently, there are approximately 35,000 problems in the OPL, and new problems are added regularly.  The OPL was initially formed from several of the original [[Problem Libraries|File Based Problem Libraries]], and includes all of the problems from the Arizona State, Rochester, California State-Long Beach, and the University of Virginia libraries.  It also contains most, if not all, of the problems from Union College, the College of New Jersey, Dartmouth, Ohio State, Northern Arizona University, and Indiana University.  Once known as the National Problem Library (NPL), the Open Problem Library (OPL) naming convention was adopted in the summer of 2012 to accommodate the increasing internationalization of WeBWorK and the possible inclusion of problem libraries from textbook publishers.
  
 
In addition to merging problem collections from multiple institutions into a single collection, WeBWorK provides a different interface to these problems.  Problems in the OPL are marked internally with metadata, and instructors can search for problems on the basis of this data.  This mechanism is built into WeBWorK's library browser.  In particular, one can search hierarchically by course, chapter, or section.  To a limited extent, problems have been indexed against sections of textbooks, in which case instructors can also search for problems on that basis.  WeBWorK stores this information in a database, so part of the installation involves loading metadata into the database.
 
In addition to merging problem collections from multiple institutions into a single collection, WeBWorK provides a different interface to these problems.  Problems in the OPL are marked internally with metadata, and instructors can search for problems on the basis of this data.  This mechanism is built into WeBWorK's library browser.  In particular, one can search hierarchically by course, chapter, or section.  To a limited extent, problems have been indexed against sections of textbooks, in which case instructors can also search for problems on that basis.  WeBWorK stores this information in a database, so part of the installation involves loading metadata into the database.
  
Faculty from institutions using WeBWorK [[Submitting problems to the OPL |are invited]] to submit new problems to the OPL.  The OPL is one of the most popular features of WeBWorK, and its value is based on the many excellent contributions that have been recieved.
+
Faculty from institutions using WeBWorK [[Submitting problems to the OPL |are invited]] to submit new problems to the OPL.  Submissions are reviewed by members of the OPL [[OPL Editorial Board]] which maintains the OPL.  The OPL is one of the most popular features of WeBWorK, and its value is based on the many excellent contributions that have been received.
  
 
== License ==
 
== License ==
Line 28: Line 28:
 
== Browsing the OPL ==
 
== Browsing the OPL ==
  
Log into a WeBWorK course and select '''Library Browser''' from the links menu. On the resulting screen, click the '''Open Problem Library''' button.
+
Log into a WeBWorK course and select '''Library Browser''' from the links menu. On the resulting screen, click the '''Open Problem Library''' button. This allows you to browse the library by a taxonomy of mathematics.  For more refined searches, one can restrict to problems which have been marked as going with a particular section of a textbook, or to certain [[Problem_Levels|Bloom's taxonomy-type levels]].
 +
 
 +
One can add a stanza in the <code>localOverrides.conf</code> file to obtain an "OPL Directory" button which will enable you to  browse the Open Problem Library subdirectories directly. 
 +
This lets you see problems based on the institution from which they came.
 +
 
 +
You can also add a button for the "Contrib" library which contains problems contributed to the OPL but not yet curated and added to the OPL itself.  In order to enable
 +
the Contrib button you will need to create, from the command line a link to the Contrib directory from templates directory of each course for which the button is to appear.
 +
 
 +
# In myCourse/templates
 +
  sudo ln -s /opt/webwork/libraries/webwork-open-problem-library/Contrib Contrib
 +
 +
  ls -l Contrib
 +
  Contrib -> /opt/webwork/libraries/webwork-open-problem-library/Contrib
 +
  
Add this stanza in the <code>global.conf</code> file to obtain an "NPL Directory" button which will enable you to
 
browse the NationalProblemLibrary subdirectories.
 
  
 
  # Additional library buttons can be added to the Library Browser (SetMaker.pm)
 
  # Additional library buttons can be added to the Library Browser (SetMaker.pm)
Line 99: Line 110:
 
  ln -s /opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary/Rochester /opt/webwork/libraries/rochesterLibrary
 
  ln -s /opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary/Rochester /opt/webwork/libraries/rochesterLibrary
 
at least in the short run to keep older set definition files working.
 
at least in the short run to keep older set definition files working.
 +
 +
== Updating the OPL ==
 +
 +
The git repository for the OPL is updated as problems are added, additional metadata is added, or problem bugs are fixed.  So, it is a good idea to update your copy of the OPL periodically, say once per semester.
 +
 +
To update, run the <code>git pull</code> command to download the latest versions from our server. Then, re-run OPL-update.
 +
 +
$ cd /opt/webwork/libraries/webwork-open-problem-library
 +
$ git pull
 +
$ OPL-update
 +
Library version is 2.5; using OPLtables!
 +
Mysql database reinitialized.
 +
Reading in textbook data from Textbooks in the library /opt/webwork/libraries/OPL.
 +
Reading in OPL taxonomy from Taxonomy in the library /opt/webwork/libraries/OPL.
 +
Converting data from tagged pgfiles into mysql.
 +
Number of files processed:
 +
  100  200  300  400  500  600  700  800  900  1000
 +
  1100  1200  1300  1400  1500  1600  1700 ...
 +
 +
$
 +
 +
 +
 +
 +
= Contributing to the OPL =
 +
 +
If you have written new problems, you might like to contribute them to the NPL so others can benefit from them as well.
 +
 +
* [[Tagging Problems]]
 +
* [[Submitting problems to the OPL]]
 +
* [[Information for OPL maintainers]]
 +
* [[OPL Editorial Board]]
 +
 +
== See also ==
 +
 +
* [[What to do if you find a bug in a problem]]
 +
 +
[[Category:Problem Libraries]]
 +
[[Category:Open Problem Library]]
 +
 +
= Legacy instructions =
  
 
== For WeBWorK 2.6 (or ww2.5.1.1) and later ==
 
== For WeBWorK 2.6 (or ww2.5.1.1) and later ==
Line 149: Line 201:
  
 
|}
 
|}
 
== Updating the OPL ==
 
 
The git repository for the OPL is updated as problems are added, additional metadata is added, or problem bugs are fixed.  So, it is a good idea to update your copy of the OPL periodically, say once per semester.
 
 
To update, run the <code>git pull</code> command to download the latest versions from our server. Then, re-run OPL-update.
 
 
$ cd /opt/webwork/libraries/webwork-open-problem-library
 
$ git pull
 
$ ./OPL-update
 
Library version is 2.5; using OPLtables!
 
Mysql database reinitialized.
 
Reading in textbook data from Textbooks in the library /opt/webwork/libraries/OPL.
 
Reading in OPL taxonomy from Taxonomy in the library /opt/webwork/libraries/OPL.
 
Converting data from tagged pgfiles into mysql.
 
Number of files processed:
 
  100  200  300  400  500  600  700  800  900  1000
 
  1100  1200  1300  1400  1500  1600  1700 ...
 
 
$
 
 
 
 
 
= Legacy instructions =
 
 
 
 
== Versions earlier than release 2.6 (or ww2.5.1.1) ==
 
== Versions earlier than release 2.6 (or ww2.5.1.1) ==
  
Line 282: Line 307:
 
  Converting data from tagged pgfiles into mysql.
 
  Converting data from tagged pgfiles into mysql.
 
  $
 
  $
 
= Contributing to the OPL =
 
 
If you have written new problems, you might like to contribute them to the NPL so others can benefit from them as well.
 
 
* [[Tagging Problems]]
 
* [[Submitting problems to the OPL]]
 
* [[Information for OPL maintainers]]
 
 
== See also ==
 
 
* [[What to do if you find a bug in a problem]]
 
 
[[Category:Problem Libraries]]
 
[[Category:Open Problem Library]]
 

Latest revision as of 14:07, 24 April 2017

This page describes the OpenProblemLibrary (OPL). The Open Problem Library was previously called the National Problem Library. We have changed the name on most pages but you may still see references to OPL's earlier incarnation as the NPL.


The WeBWorK Open Problem Library (OPL) contains problems contributed by faculty from many institutions that have used WeBWorK. Currently, there are approximately 35,000 problems in the OPL, and new problems are added regularly. The OPL was initially formed from several of the original File Based Problem Libraries, and includes all of the problems from the Arizona State, Rochester, California State-Long Beach, and the University of Virginia libraries. It also contains most, if not all, of the problems from Union College, the College of New Jersey, Dartmouth, Ohio State, Northern Arizona University, and Indiana University. Once known as the National Problem Library (NPL), the Open Problem Library (OPL) naming convention was adopted in the summer of 2012 to accommodate the increasing internationalization of WeBWorK and the possible inclusion of problem libraries from textbook publishers.

In addition to merging problem collections from multiple institutions into a single collection, WeBWorK provides a different interface to these problems. Problems in the OPL are marked internally with metadata, and instructors can search for problems on the basis of this data. This mechanism is built into WeBWorK's library browser. In particular, one can search hierarchically by course, chapter, or section. To a limited extent, problems have been indexed against sections of textbooks, in which case instructors can also search for problems on that basis. WeBWorK stores this information in a database, so part of the installation involves loading metadata into the database.

Faculty from institutions using WeBWorK are invited to submit new problems to the OPL. Submissions are reviewed by members of the OPL OPL Editorial Board which maintains the OPL. The OPL is one of the most popular features of WeBWorK, and its value is based on the many excellent contributions that have been received.

Contents

License

Unless otherwise indicated, copyrights on the content contributed to the WeBWorK Open Problem Library are held by the author(s) of that content. This includes the problem files (*.pg) and any associated auxililary files such as images and custom macro files.

Unless otherwise indicated, all contributions to the WeBWorK Open Problem Library are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/

See license on github site for more details: https://github.com/openwebwork/webwork-open-problem-library/blob/master/OPL_LICENSE

Browsing the OPL

Log into a WeBWorK course and select Library Browser from the links menu. On the resulting screen, click the Open Problem Library button. This allows you to browse the library by a taxonomy of mathematics. For more refined searches, one can restrict to problems which have been marked as going with a particular section of a textbook, or to certain Bloom's taxonomy-type levels.

One can add a stanza in the localOverrides.conf file to obtain an "OPL Directory" button which will enable you to browse the Open Problem Library subdirectories directly. This lets you see problems based on the institution from which they came.

You can also add a button for the "Contrib" library which contains problems contributed to the OPL but not yet curated and added to the OPL itself. In order to enable the Contrib button you will need to create, from the command line a link to the Contrib directory from templates directory of each course for which the button is to appear.

# In myCourse/templates
 sudo ln -s /opt/webwork/libraries/webwork-open-problem-library/Contrib Contrib

 ls -l Contrib
 Contrib -> /opt/webwork/libraries/webwork-open-problem-library/Contrib


# Additional library buttons can be added to the Library Browser (SetMaker.pm)
# by adding the libraries you want to the following line.  For each key=>value
# in the list, if a directory (or link to a directory) with name 'key' appears
# in the templates directory, then a button with name 'value' will be placed at
# the top of the problem browser.  (No button will appear if there is no
# directory or link with the given name in the templates directory.)  For
# example,
# 
#     $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
# 
# would add two buttons, one for the Rochester library and one for the ASU
# library, provided templates/rochester and templates/asu exists either as 
# subdirectories or links to other directories. The "OPL Directory" button
# activated below gives access to all the sub directories in the Open 
# Problem Library.
# 
    $courseFiles{problibs}    = {
         Library          => "OPL Directory",
       #       rochesterLibrary => "Rochester", 
       #       asuLibrary       => "Arizona State",
       # 	dcdsLibrary      => "Detroit CDS",
       # 	dartmouthLibrary => "Dartmouth",
       # 	indianaLibrary   => "Indiana",
       # 	osuLibrary       => "Ohio State",	
       #	capaLibrary      => "CAPA",
       #	ucsbLibrary        => "UCSB"
   };

Obtaining the OPL

The Open Problem Library can be checked out from the WeBWorK github repository via

 cd /opt/webwork/libraries
 sudo git clone https://github.com/openwebwork/webwork-open-problem-library.git

You may or may not need to use sudo depending on the permissions assigned to the libraries directory.

Insure that the permissions are set so that the webwork server can read the files in the OpenProblemLibrary.

git is a command that is already installed on most unix systems. If not there are standard simple instructions for installing it on your platform available via google search.

Installing the OPL

Assuming the rest of WeBWorK is in /opt/webwork/ proceed as follows to install the OPL. First, make sure you have an /opt/webwork/libraries directory:

 mkdir -p /opt/webwork/libraries

The OPL can be downloaded from the OPL github.com repository directly into the library directory. It creates a directory called webwork-open-problem-library containing the library. The full path to the library will be /opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary. This is the library address that should be included in webwork2/conf/localOverrides.conf.

cd /opt/webwork/libraries
sudo git clone https://github.com/openwebwork/webwork-open-problem-library.git.

For backwards compatibility one can create symbolic links to:

  ln -s /opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary /opt/webwork/libraries/NationalProblemLibrary

Alternatively one can update the Library link in each course courseName/templates/Library. This requires more work but is a better solution in the long run. It can be done with a script.

Depending on your previous setup, you may have to create additional symbolic links from the previous locations of libraries to the current ones. In particular, the popular file libraries are now contained in the National Problem Library, so you may need links such as

ln -s /opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary/Rochester /opt/webwork/libraries/rochesterLibrary

at least in the short run to keep older set definition files working.

Updating the OPL

The git repository for the OPL is updated as problems are added, additional metadata is added, or problem bugs are fixed. So, it is a good idea to update your copy of the OPL periodically, say once per semester.

To update, run the git pull command to download the latest versions from our server. Then, re-run OPL-update.

$ cd /opt/webwork/libraries/webwork-open-problem-library
$ git pull
$ OPL-update
Library version is 2.5; using OPLtables!
Mysql database reinitialized.
Reading in textbook data from Textbooks in the library /opt/webwork/libraries/OPL.
Reading in OPL taxonomy from Taxonomy in the library /opt/webwork/libraries/OPL.
Converting data from tagged pgfiles into mysql.
Number of files processed:
  100   200   300   400   500   600   700   800   900  1000
 1100  1200  1300  1400  1500  1600  1700 ...

$



Contributing to the OPL

If you have written new problems, you might like to contribute them to the NPL so others can benefit from them as well.

See also

Legacy instructions

For WeBWorK 2.6 (or ww2.5.1.1) and later

Modify configuration file and run update

Enter the path to the OpenProblemLibrary into the config file webwork2/conf/localOverrides.conf and set the library version number to 2.5


 $problemLibrary{root}        ="/opt/webwork/libraries/webwork-open-problem-library/OpenProblemLibrary";
 $problemLibrary{version}     ="2.5";


Then run webwork2/bin/OPL-update from the command line to update the meta-data for the current collection of problems in the library.

 cd /opt/webwork/webwork2/bin/
 ./OPL-update


(You will need to have defined WEBWORK_ROOT in your shell environment.)


Configuring your shell in order to run OPL-update from the command line

To make working with WeBWorK easier, there are a couple of changes you can make to your shell environment.

Add the WeBWorK bin directory to your path. This will allow you to run WeBWorK command-line utilities without typing the full path to the utility. If you installed WeBWorK in the default location of /opt/webwork/webwork2, add the directory /opt/webwork/webwork2/bin to your path.

if your shell is put this line in this file
bash export PATH=$PATH:/opt/webwork/webwork2/bin ~/.bashrc
tcsh setenv PATH $PATH:/opt/webwork/webwork2/bin ~/.cshrc

Set the WEBWORK_ROOT environment variable. Some command-line scripts rely on this variable to find other WeBWorK files.

if your shell is put this line in this file
bash export WEBWORK_ROOT=/opt/webwork/webwork2 ~/.bashrc
tcsh setenv WEBWORK_ROOT /opt/webwork/webwork2 ~/.cshrc

Versions earlier than release 2.6 (or ww2.5.1.1)

Upgrade to release 2.6. Seriously!


Release 2.6 (renamed from ww2.5.1.1) has been in wide spread use for more than a year. You should definitely consider updating to 2.6. In particular this version contains redesigned configuration files that allow you to upgrade to subsequent versions such as release 2.7 with few if any modifications to the configuration files. This also allows you to backtrack to earlier versions if you feel you have upgraded prematurely. Version 2.7 supports essayQuestions among other enhancements. Both version 2.6 and 2.7 support achievements.


If you must use an earlier version of webwork here are the legacy instructions. Good luck. :-)

If you are running WeBWorK 2.3.x, you must create a ProblemLibrary database on your MySQL server. (***** represents the MySQL root password.)

$ mysql -u root
Password: *****
> CREATE DATABASE ProblemLibrary;
> GRANT SELECT on ProblemLibrary.* TO webworkWrite@localhost;
> quit
Bye.
$

If you are running WeBWorK 2.4.x, this is not necessary since the NPL indexes are stored within the main webwork database.

Configure WeBWorK to access the problem library. The settings are in global.conf:

For WeBWorK 2.3.x:

variable description
$problemLibrary{root} Path to NationalProblemLibrary directory. Should be /opt/webwork/libraries/NationalProblemLibrary.
$problemLibrary{version} Version of the problem library database. Should be =2=.
$problemLibrary{sourceSQL} Name of the database. Should be ProblemLibrary.
$problemLibrary{userSQL} Username to use when connecting to the database. Can usually be left as $database_username.
$problemLibrary{passwordSQL} Password to use when connecting to the database. Can usually be left as $database_password.

For WeBWorK 2.4.x

variable description
$problemLibrary{root} Path to NationalProblemLibrary directory. Should be /opt/webwork/libraries/NationalProblemLibrary.
$problemLibrary{version} Version of the problem library database. Should be =2=.
$problemLibrary_db{dbsource} Name of the database. Can usually be left as $database_dsn.
$problemLibrary_db{user} Username to use when connecting to the database. Can usually be left as $database_username.
$problemLibrary_db{passwd} Password to use when connecting to the database. Can usually be left as $database_password.

Finally, populate the database:

For WeBWorK 2.3.x:

Run the loadDB2 script to populate the database. This script must be run from the database_problems directory.

$ cd /opt/webwork/libraries/database_problems
$ ./loadDB2
What is the root password for mysql? *****
Mysql database reinitialized
Converting data from tagged pgfiles into mysql.
$ 

For WeBWorK 2.4.x:

Run the NPL-update script to populate the database. This script is located in the webwork2/bin directory and may be invoked from anywhere.

$ /opt/webwork/webwork2/bin/NPL-update
Mysql database reinitialized.
Reading in textbook data.
Converting data from tagged pgfiles into mysql.
Number of files processed:
   100   200   300   400   500   600   700   800   900  1000
...
Done.
$ 

There is no need to add symlinks to course templates directory, as is necessary with file based Problem Libraries. It is done automatically.

Updating the NPL

The SVN repository for the NPL is updated as problems are added, additional metadata is added, or problem bugs are fixed. So, it is a good idea to update your copy of the NPL periodically, say once per semester.

To update, run the svn update command to download the latest versions from our server. Then, re-run loadDB2 (WeBWorK 2.3.x) or NPL-update (WeBWorK 2.4.x).

$ cd /opt/webwork/libraries/NationalProblemLibrary
$ svn up
$ ./NPL-update
What is the root password for mysql? ***** (#Or the webworkWrite user, following recent installation instructions)
Mysql database reinitialized
Converting data from tagged pgfiles into mysql.
$
follow us