Skip to content

markgbeckett/python-intermediate-inflammation

Repository files navigation

Inflam

Continuous Integration build in GitHub Actions

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

Document history

10/DEC/21 -- Initial version created.

Acknowledgements

The software has been developed by the Software Sustainability Institute as part of the basic training material for their Intermediate Research Software Engineering course.

Licence

Apache License Version 2.0. See the LICENSE.txt file, which should be included in this distribution.

Joke

Q: Why do computer scientists confuse Halloween and Christmas?

A: Because OCT 31 = DEC 25

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 and Testing

The software is available on GitHub.

Having obtained a copy, you should install the prerequisites (see Prerequisites).

To test that your installation is working, run the various tests in the test subdirectory. For example:

python3 tests/test_models.py

Successful tests produce no output.

About

Course project for SSI intermediate research software engineering course.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages