vizcovidfr

A python package to visualize spatial evolution of Covid19 cases in France

The documentation of vizcovidfr is available here.

Project description

As part of our course HMMA238 'Software Development' at the university of Montpellier, we worked on a team project, and the result is a python package that can be installed by entering the following line in a terminal:

$ pip install git+https://github.com/AmelieVernay/vizcovidfr/

You can also use the command

$ pip install vizcovidfr==0.0.5

but this version might not have the very last changes, even though we are doing our best to maintain it up to date.

The goal of our project was to analyze the spreading of the covid19 disease in France. The main idea was to provide a python package for Covid data visualization. The package contains several sub-modules, each of which containing several functions for specific visualization purpose. One should be able to use these by passing arguments corresponding to the desired output. We wanted our package to be easy to use and tried to build a documentation as clear and detailed as possible.

We use Covid-related datasets available on data.gouv.fr.

Oral presentation (due date : April 25, 2021)

Our beamer presentation for vizcovidfr is available on GitHub (./beamer folder) and here on YouTube.

Members

• Foux Quentin, [email protected]
• Llinares Laurent, [email protected]
• Nicolas Alexandre, [email protected]
• Vernay Amelie, [email protected]

Roles

• Foux Quentin: line charts / piecharts / maps (vacmap)

• Llinares Laurent: line charts / bar plots / heatmap

• Nicolas Alexandre: bar plots / regression / prediction

• Vernay Amelie: maps / sparse matrices / plots / time efficiency

• Everyone: module architecture, documentation, unit tests...

Sources

During our work, we found help on many different places, in addition to our HMMA238.

For the package structure and the documentation

• the package chaoseverywhere built by some of our predecessors
• this python-guide about packages
• the Sphinx documentation about documentation

For the code part

• the documentation of all the packages that figure in the requirement.txt file.
• the public platform stackoverflow was very helpful.