Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0nom4d/306radiator

Mathematical EPITECH Project - This project reproduces the behaviour of a radiator placed at a position in a room of a given size.
https://github.com/0nom4d/306radiator

epitech epitech-project numpy pytest python3

Last synced: 11 days ago
JSON representation

Mathematical EPITECH Project - This project reproduces the behaviour of a radiator placed at a position in a room of a given size.

Awesome Lists containing this project

README

        

# 306radiator

306radiator is a B-MAT-500 EPITECH module project.

306radiator is about the heat coming out of a radiator.

## Before continuing...

This project is an EPITECH Project. If you are an EPITECH student, move out the way!

Nothing to see here... The groups don't want to be involved to your -42.

![Alt Text](https://media.tenor.com/images/5a5f5957db8b98be17ef208737663b9b/tenor.gif)

If you're not, no worries! You're welcome here!

### Prerequisites

To use this project, you'll need Python (Version 3.8) and Pytest for Unit Tests:

* [Python Installation](https://www.python.org/downloads/)
* [Pytest Installation](https://docs.pytest.org/en/6.2.x/getting-started.html#install-pytest)

### Building program

306radiator is a B-MAT-500 EPITECH module project.

306radiator is about the heat coming out of a radiator.

You can use this program as it follows:

```textmate
$> ./306radiator --help
USAGE
./306radiator n ir jr [i j]

DESCRIPTION
n size of the room
(ir, jr) coordinates of the radiator
(i, j) coordinates of a point in the room
```

You can also launch unit tests by using the command below at root of the repository:

```textmate
$> coverage run --rcfile=.coveragerc -m --source=sources/ pytest --capture=sys -rA tests/
============================= test session starts ==============================
platform linux -- Python 3.8.10, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
rootdir: /home/nom4d/EPITECH/306radiator
collected ... items

...

==================================== PASSES ====================================
_____________________ ... ______________________
----------------------------- Captured stdout call -----------------------------
...
=========================== short test summary info ============================
...
============================== ... passed in ...s ===============================
$> coverage report -m
// In order to show coverage report
```

### Coding Style

306radiator is developed with Python. EPITECH doesn't impose any Coding Style to this but I tried to be as cleaner as possible.

## Authors

* **Arthur Adam** - [0Nom4D](https://github.com/0Nom4D)
* **Mathis Ragot** - [Mathis-Ragot](https://github.com/Mathis-Ragot)

This README file has been created with mdCreator. [Please check the project by clicking this link.](https://github.com/0Nom4D/mdCreator/)