mypydavid/elchempy

A Python framework for the processing and analysis of different types of electrochemical experiments.

elchempy

This repository contains packages for the processing of electrochemical (EC) experiments in Python. I have used these packages for my scientific projects. However, this repository is an attempt to refactor and develop these packages into a clear application architecture. Therefore...

🚨 🚧 🏗️ This repo is still under construction 👷‍♂️...

However... A first test run can be made. Files (*.par) should be placed in the data/raw folder at the repo top. For this to work, the package should be cloned and installed in editable mode.

import elchempy
from elchempy.api import N2_testrun
N2_scans = N2_testrun()
# inline plotting multiple figures
[i._test_plot_scanrates() for i in N2_scans]
[i._test_plot_Cdl() for i in N2_scans]

Getting started

To start contributing to elchempy, run the following commands in your shell:

make requirements

Requirements

• Python 3.7+ installed
• A .secrets file with the required secrets and credentials
• Load environment variables from .envrc

Required secrets and credentials

To run this project, you need a .secrets file with secrets/credentials as environmental variables; see the documentation for further guidance. The secrets/credentials should have the following environment variable name(s):

Secret/credential	Environment variable name	Description
Secret 1	SECRET_VARIABLE_1	Plain English description of Secret 1.
Credential 1	CREDENTIAL_VARIABLE_1	Plain English description of Credential 1.

Once you've added these environment variables to .secrets you will need to load them via .envrc.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

Contributing

If you want to help us build, and improve elchempy, view our contributing guidelines.

Acknowledgements

This project structure is based on the govcookiecutter template project.