Metadata-Version: 2.1
Name: fairmaterials
Version: 0.2.0
Summary: Generate  JSON-LD format file based on FAIRification standard
Home-page: UNKNOWN
Author: Mingjian Lu,Liangyi Huang, Will Oltjen,Xuanji Yu,Arafath Nihar, Tommy Ciardi, Erika Barcelos,Pawan Tripathi,Abhishek Daundkar,Deepa Bhuvanagiri,Hope Omodolor,Hein Htet Aung,Kristen Hernandez,Mirra Rasmussen,Raymond Wieser, Sameera Nalin Venkat,Tian Wang, Weiqi Yue, Yangxin Fan,Rounak Chawla,Leean Jo,Zelin Li,Jiqi Liu, Justin Glynn, Kehley Coleman,Jeffery Yarus, Mengjie Li,Kristopher.Davis, Laura Bruckman,Yinghui Wu,Roger French
Author-email: mxl1171@case.edu,lxh442@case.edu, wco3@case.edu,xxy530@case.edu ,arafath@case.edu,tgc17@case.edu,eib14@case.edu,pkt19@case.edu,aad157@case.edu,dcb117@case.edu,hxo76@case.edu,hxh483@case.edu,kjh125@case.edu,mmr125@case.edu,rxw497@case.edu,sxn440@case.edu,txw387@case.edu,wxy215@case.edu,yxf451@case.edu,rxc542@case.edu,yxj414@case.edu,zxl1080@case.edu,jxl1763@case.edu,jpg90@case.edu,kac196@case.edu,jmy41@case.edu,Mengjie.Li@ucf.edu,Kristopher.Davis@ucf.edu,lsh41@case.edu,yxw1650@case.edu,rxf131@case.edu
License: BSD License (BSD-3)
Project-URL: HomePage, https://cwrusdle.bitbucket.io
Project-URL: Documentation, https://cwrusdle.bitbucket.io/fairmaterials-py/index.html
Keywords: FAIRification,PowerPlant,Engineering
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.txt


![logo](https://i.imgur.com/pqR2OBe.png)

# Fairmaterials
Fairmaterials is a Python 3 package developed by the SDLE Research Center at Case Western Reserve University in Cleveland OH.
Fairmaterials is a tool for fairing data. It reads a template JSON-LD file to get the preset data. The user can edit the data by manually inputting or by importing a csv file or dataframe. The output will be a sequence of JSON-LD files with the fairified data inside. 


# Features
 -  Importing JSON template as JSON-LD.
 -   Modify JSON data.
		- Based on CSV file.
		- Based on dataframe file
 -   Output fairiried data as standard JSON-LD format file.
 
#  Setup
1. Install it at bash
```bash
$ pip install fairmaterials
```
2.	Import it in python
```python
from fairmaterials.fairify_data import *
``` 
#  A quick example
***Select a domain and data need to be fairiried***
```python
fairify_data(dataframe,"XRD")
``` 
***Output will be series of json-ld format file***

#  Versions
All notable changes to this project will be documented in this file.
## [0.2.0] - 2023-01-10
### Added
- Update fairify_data function,user can select domains to fairify data and dataframe has items from different domains can be fairify into different json-ld file 
- Add new domains into package
#### Domains
- XRD
- CapillaryElectrophoresis
- PolymerAM
- PVModule
- PolymerBacksheets
- OpticalSpectroscopy
- Buildings
- MetalAM
- OpticalProfilometry
- PVSystem
- XCT
- PolymerFormulations
- MaterialsProcessing 
- PVCells
- PVInverter

## [0.1.2] - 2022-12-10
### Added
- Add fairify_data function,user can select domains to fairify data
#### Domains
- XRD
- CapillaryElectrophoresis
- PolymerAM
- PVModule
- PolymerBacksheets
- OpticalSpectroscopy
- Buildings
- GeospatialWell
- MetalAM
- OpticalProfilometry
- PVSystem
- XCT 

## [0.0.213] - 2022-10-8
### Added
- Add template csv file.
## [0.0.212] - 2021-10-7
### Added
- Add group input CSV file generation function.
- Add directly convert a group input CSV file to multiple json file function.
- Add Version part in Readme.md file.

## Funding Acknowledgements:
This work was supported by the U.S. Department of Energy’s Office of Energy Efficiency and Renewable Energy (EERE) under Solar Energy Technologies Office (SETO) Agreement Numbers DE-EE0009353 and DE-EE0009347, Department of Energy (National Nuclear Security Administration) under Award Number DE-NA0004104 and Contract number B647887, and U.S. National Science Foundation Award under Award Number 2133576.

