Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/0nom4d/308reedpipes

Mathematical EPITECH Project - This project computes a representation of a reedpipe.
https://github.com/0nom4d/308reedpipes

coverage epitech epitech-project matplotlib-pyplot numpy pytest python scipy

Last synced: 7 days ago
JSON representation

Mathematical EPITECH Project - This project computes a representation of a reedpipe.

Awesome Lists containing this project

README

        

# 308reedpipes

308reedpipes is a B-MAT-500 EPITECH module project.

308reedpipes is about helping you cousin with his reed pipe enthusiasm.

## Before continuing...

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

Nothing to see here... I 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

308reedpipes is a B-MAT-500 EPITECH module project.

308reedpipes is about helping you cousin with his reed pipe enthusiasm.

You can use this program as it follows:

```textmate
$> ./308reedpipes -h
USAGE
./308reedpipes r0 r5 r10 r15 r20 n
DESCRIPTION
r0 radius (in cm) of pipe at the 0cm abscissa
r5 radius (in cm) of pipe at the 5cm abscissa
r10 radius (in cm) of pipe at the 10cm abscissa
r15 radius (in cm) of pipe at the 15cm abscissa
r20 radius (in cm) of pipe at the 20cm abscissa
n number of points needed to display the radius
```

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/307multigrains
collected ... items

...

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

### Coding Style

308reedpipes 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)

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