Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 731 Bytes

README.md

File metadata and controls

40 lines (33 loc) · 731 Bytes

PhIRL

Project description to follow.

Installation

  1. Make sure you use Python 3.7 (or later).
  2. Install the requirements:
$ pip install -r requirements/basic.txt
  1. Install the package in editable mode:
$ pip install -e .

Usage

We develop a Python module, which can be imported as

import phirl.api as ph

as well as a set of scripts used to run individual experiments.

Their usage description will follow.

Contributing

If you plan to work on the code, the following tools will be required:

  1. Install additional dependencies:
$ pip install -r requirements/dev.txt
  1. Install pre-commit hooks:
$ pre-commit install
  1. Check if you can run the tests:
$ pytest