https://github.com/wright-group/make-it-wright
Jin Group Tools for handling Wright Group type data (and similar).
https://github.com/wright-group/make-it-wright
Last synced: 5 months ago
JSON representation
Jin Group Tools for handling Wright Group type data (and similar).
- Host: GitHub
- URL: https://github.com/wright-group/make-it-wright
- Owner: wright-group
- License: mit
- Created: 2025-08-17T16:51:28.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-12T17:38:12.000Z (9 months ago)
- Last Synced: 2025-09-12T19:57:17.153Z (9 months ago)
- Language: Python
- Size: 262 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# make-it-wright
Jin Group Tools for handling a variety of common data.
Builds upon the WrightTools Data object.
## Features
- a module for each instrument featured
- AFM (Gwiddion)
- Andor Neo Camera (Solis)
- Becker and Hickl SPCM
- Horiba LabRAM
- Generic Images
- ion TOF
- XRD (Bruker)
- preset styles and routines for making quick figures
## Installation
### Basic
First download this repository and unzip it.
Navigate to the package directory (the folder containing the "pyproject.toml" file).
Create a conda environment for this package:
```
conda create -n makeitwright pip
conda activate makeitwright
```
Still in this directory, install the package:
```
pip install .
```
If you wish to install in editable mode, use the same steps of above, but include the editable flag when installing:
```
pip install --editable .
```
For whatever IDE you use (pyCharm, Spyder, VSCode), be sure to configure the editor so that you use the correct Conda environment (consult the documentation for the IDE).
### IonTOF
support for iontof data is optional; if you need to use iontof data, specify additional imports using:
`pip install .[iontof]`
Note that at the time of this writing, iontof must be used on python version <3.13.
## Examples
TODO