Skip to content

tms-epcc/python-intermediate-inflammation

Repository files navigation

Inflam

Inflam is a data management system written in Python that manages trial data used in clinical inflammation studies.

Continuous Integration build in GitHub Actions

Main Features

Here are some key features of Inflam:

  • Provide basic statistical analyses over clinical trial data
  • Ability to work on trial data in Comma-Separated Value (CSV) format
  • Generate plots of trial data
  • Analytical functions and views can be easily extended based on its Model-View-Controller architecture

Prerequisites

Inflam requires the following Python packages:

  • NumPy - makes use of NumPy's statistical functions
  • Matplotlib - uses Matplotlib to generate statistical plots

The following optional packages are required to run Inflam's unit tests:

  • pytest - Inflam's unit tests are written using pytest
  • pytest-cov - Adds test coverage stats to unit testing

Installation/deployment:

step-by-step instructions for setting up the software so it can be used

Basic usage:

step-by-step instructions that cover using the software to accomplish basic tasks

Contributing:

for those wishing to contribute to the software’s development, this is an opportunity to detail what kinds of contribution are sought and how to get involved

Contact information/getting help:

which may include things like key author email addresses, and links to mailing lists and other resources

Credits/Acknowledgements:

where appropriate, be sure to credit those who have helped in the software’s development or inspired it

Citation:

particularly for academic software, it’s a very good idea to specify a reference to an appropriate academic publication so other academics can cite use of the software in their own publications and media. You can do this within a separate CITATION text file within the repository’s root directory and link to it from the markdown

Licence:

a short description of and link to the software’s licence

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages