Skip to main content

A comprehensive package for the analysis of kinetic data.

Project description

Documentation Status License: GPL v3 https://anaconda.org/erdzeichen/kimopack/badges/installer/conda.svg https://badge.fury.io/py/KiMoPack.svg https://anaconda.org/erdzeichen/kimopack/badges/latest_release_date.svg https://mybinder.org/badge_logo.svg https://zenodo.org/badge/400527965.svg

KiMoPack

KiMoPack is a project for the handling of spectral data measure at multiple time-points. The current design is optimised for the use with optical transient absorption data, but it has been successfully adapted for the use with transient x-ray emission and spectro-electro chemistry data.

It focuses on the main tasks an experimentator has: Loading and shaping of experiments, plotting of experiments, comparing of experiments, analysing experiments with fast and/or advanced fitting routines and saving/exporting/presenting the results.

For typical use a series of juypter notebooks are provided that guide through the a number of different use scenarios, and are suggesting the parameter that are typically set.

Installation

The basis of the program is a module called “plot_func.py” that contains all the necessary functions and classes. We provide a series of jupyter based work flow packages that guide the user through a series of typical tasks during the analysis of optical transient absorption data and that we strongly recommend. The files can be downloaded from the github directory https://github.com/erdzeichen/KiMoPack and manually installed (added to the path). Alternatively we recommend the usage of the usual python install commands “pip” or if the distribution is using the Anaconda package manager, The conda type installation. For both please open a command line (e.g. using “cmd” in windows) and execute the following commands. The Jupyter notebooks are copied during the install process. The notebooks can also be downloaded from the github server https://github.com/erdzeichen/KiMoPack.

Install using “pip”:

$ pip install KiMoPack

Upgrade if already installed:

$ pip install KiMoPack -U

Install and update using “conda” from the channel erdzeichen:

$ conda install -c erdzeichen kimopack

Best usage

While KiMoPack is a python library, we facilitate its use with Jupyter notebooks. For the typical analysis tasks we have developed a series of Notebooks that guide through the tasks.n These notebooks can be downloaded from https://github.com/erdzeichen/KiMoPack/tree/main/Workflow_tools or by command line.

To do that start any console (under windows e.g. type “cmd” and hit enter). In the console you then start python by typing “python” and hit enter, lastly you import Kimopack and run a function that downloads the files for you by typing “import KiMoPack.plot_func as pf; pf.download_all()” This downloads the notebooks and tutorials from github for you. If you instead use “import KiMoPack.plot_func as pf; pf.download_notebooks()” then only the workflow tools are downloaded. Please copy one of these notebooks into your data analysis folder and rename them to create a analysis log of your session. For more information please see the publication https://doi.org/10.1021/acs.jpca.2c00907, the tutorial videos, or the tutorial notebooks under https://github.com/erdzeichen/KiMoPack/tree/main/Tutorial_Notebooks_for_local_use.

Citation

We have written and submitted a paper introducing the toolbox under https://doi.org/10.1021/acs.jpca.2c00907

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

KiMoPack-6.11.2.tar.gz (871.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

KiMoPack-6.11.2-py3-none-any.whl (103.9 kB view details)

Uploaded Python 3

File details

Details for the file KiMoPack-6.11.2.tar.gz.

File metadata

  • Download URL: KiMoPack-6.11.2.tar.gz
  • Upload date:
  • Size: 871.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for KiMoPack-6.11.2.tar.gz
Algorithm Hash digest
SHA256 584a0a54502e44314c82ca824d5a5f8dfb8e0bf2573d752a2f8908f68dea0b8e
MD5 f69a199ac5d2993d76078ea18abaa364
BLAKE2b-256 d472e0a3b03b2178f2311fba0cddc269df1c3826013b8ff00c4916cb2001e00e

See more details on using hashes here.

File details

Details for the file KiMoPack-6.11.2-py3-none-any.whl.

File metadata

  • Download URL: KiMoPack-6.11.2-py3-none-any.whl
  • Upload date:
  • Size: 103.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for KiMoPack-6.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 478d50d522a7677d36e2a0f54100399208fa9d81a18b6ddc52c27c178c29b8d0
MD5 ee76e9475074f2f0a5c44af04cc2a3b2
BLAKE2b-256 49da513009012c2941345c852eb5712ccd2f5430d91382083eb73b80da18edb1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page