Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 2.35 KB

README.rst

File metadata and controls

74 lines (58 loc) · 2.35 KB

RIMS Evaluation Software

Tests rimseval PyPi rimseval Documentation Status Code Coverage License: MIT Code style: black

Introduction

The goal of this project is to provide a python interface to process resonance ionization mass spectrometry (RIMS) data.

A detailed user guide documenting the package can be found here.

Package installation

pip install rimseval

If pre-releases are available and you would like to install one, add the --pre flag to above command. More information in the documentation.

Note

It is highly recommended that you use a virtual environment, since numpy is pinned to a specific version in order to appropriately work with numba.

RIMSEvalGUI

A GUI that wraps around the rimseval package is available on GitHub. The above mentioned documentation also serves as the documentation for this GUI.

Contributing

Contributions are very welcome! Especially the documentation could need some more examples and polishing. Please feel free to contact me if you'd like to contribute.

The documentation also contains a developers guide, if you are interested in contributing to the code base itself.