PyRat

This repository contains the software used in the
computer science course at IMT Atlantique.

The course contents is available at this address:
https://hub.imt-atlantique.fr/ueinfo-fise1a/.

Install

Standard installation procedure

Installation of the PyRat software can be done directly using pip.
Do not clone or download the repository.
Instead, please follow the following instructions:

1. First, make sure that Git is installed (or use the alternate procedure below).
   Check the instructions corresponding to your operating system here.

2. Install the PyRat software using the following command:

   • Windows – python -m pip install --user git+https://github.com/BastienPasdeloup/PyRat.git
   • Linux – pip install --user git+https://github.com/BastienPasdeloup/PyRat.git
   • MacOS – pip install --user git+https://github.com/BastienPasdeloup/PyRat.git

Alternate installation procedure without installing Git

If you do not wish to install Git, you can follow these instructions instead of those above:

1. Click on the green <> Code button on top of this page, and click on "Download ZIP".

2. Extract the downloaded archive and navigate (using the cd command) there in a terminal. Then, run the following command:

   • Windows – python -m pip install .
   • Linux – pip install .
   • MacOS – pip install .

Setup your workspace

Whatever installation method you chose, now follow the following instructions to prepare your PyRat workspace:

3. Open a terminal and navigate (using the cd command) to the directory where you want to create your PyRat workspace.

4. Then, run the following command to create a PyRat workspace in the current directory:

   • Windows – python -c "import pyrat; pyrat.create_workspace('.')"
   • Linux – python3 -c "import pyrat; pyrat.create_workspace('.')"
   • MacOS – python3 -c "import pyrat; pyrat.create_workspace('.')"

5. Finally, run the following command to generate the PyRat documentation:

   • Windows – python -c "import pyrat; pyrat.generate_documentation('pyrat_workspace')"
   • Linux – python3 -c "import pyrat; pyrat.generate_documentation('pyrat_workspace')"
   • MacOS – python3 -c "import pyrat; pyrat.generate_documentation('pyrat_workspace')"

Check installation

Once installed, please head to the course website, and follow instructions to start your first PyRat game.