Skip to content

matsuda0528/swallow

Repository files navigation

Ruby

Swallow

Swallow is University Course Timetabling Problem (UCTTP) Solver with AUK. AUK is a Domain Specific Language that can describe UCTTP.

Swallow can use SAT Solver to quickly solve for UCTTP. An interface to SAT Solver is provided by Ravensat.

Installation

SAT solver install

Install Minisat for Linux(Debian):

$ sudo apt install minisat

for MacOS:

$ brew install minisat

Install from GitHub: See Minisat(GitHub)

swallow setup

After cloning this repository, set it up with the following command.

$ ./bin/setup

Usage

Usage: swallow [options] <auk_file> -d, --debug (default: false) -f, --format [VALUE] [auk | html | csv] (default: auk) -s, --solver [VALUE] (default: minisat)

Solve for AUK

AUK file samples are located under example/.

$ ruby exe/swallow AUK_FILE_PATH

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/matsuda0528/swallow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Swallow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published