Metadata-Version: 2.4
Name: FoSpy
Version: 0.2.2
Summary: A package for opening, editing, and saving Files of Synthesis (*.fos)
Project-URL: Homepage, https://github.com/errthumt/FoSpy
Project-URL: Issues, https://github.com/errthumt/FoSpy/issues
Author: Travis Errthum
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: chemformula
Requires-Dist: pandas
Requires-Dist: pint
Requires-Dist: tabulate
Provides-Extra: all
Requires-Dist: cif2xrd>=1.0.3; extra == 'all'
Requires-Dist: matplotlib; extra == 'all'
Requires-Dist: numpy; extra == 'all'
Requires-Dist: pybaselines; extra == 'all'
Requires-Dist: pymatgen; extra == 'all'
Requires-Dist: pyqtgraph; extra == 'all'
Requires-Dist: pyside6-essentials; extra == 'all'
Requires-Dist: scipy; extra == 'all'
Provides-Extra: app
Requires-Dist: pyqtdarktheme; extra == 'app'
Requires-Dist: pyqtgraph; extra == 'app'
Requires-Dist: pyside6-essentials; extra == 'app'
Provides-Extra: cif2xrd
Requires-Dist: cif2xrd>=1.0.3; extra == 'cif2xrd'
Requires-Dist: matplotlib; extra == 'cif2xrd'
Requires-Dist: numpy; extra == 'cif2xrd'
Requires-Dist: pybaselines; extra == 'cif2xrd'
Requires-Dist: pymatgen; extra == 'cif2xrd'
Requires-Dist: scipy; extra == 'cif2xrd'
Provides-Extra: dans-diff
Requires-Dist: dans-diffraction; extra == 'dans-diff'
Requires-Dist: matplotlib; extra == 'dans-diff'
Requires-Dist: numpy; extra == 'dans-diff'
Requires-Dist: pybaselines; extra == 'dans-diff'
Requires-Dist: pymatgen; extra == 'dans-diff'
Requires-Dist: scipy; extra == 'dans-diff'
Provides-Extra: dev
Requires-Dist: cif2xrd>=1.0.3; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: numpy; extra == 'dev'
Requires-Dist: pybaselines; extra == 'dev'
Requires-Dist: pymatgen; extra == 'dev'
Requires-Dist: pyqtgraph; extra == 'dev'
Requires-Dist: pyside6-essentials; extra == 'dev'
Requires-Dist: questionary; extra == 'dev'
Requires-Dist: scipy; extra == 'dev'
Provides-Extra: dev-test
Requires-Dist: questionary; extra == 'dev-test'
Provides-Extra: diffraction
Requires-Dist: matplotlib; extra == 'diffraction'
Requires-Dist: numpy; extra == 'diffraction'
Requires-Dist: pybaselines; extra == 'diffraction'
Requires-Dist: pymatgen; extra == 'diffraction'
Requires-Dist: scipy; extra == 'diffraction'
Provides-Extra: pyside
Requires-Dist: pyqtgraph; extra == 'pyside'
Requires-Dist: pyside6-essentials; extra == 'pyside'
Provides-Extra: qt-plotting
Requires-Dist: pyqtgraph; extra == 'qt-plotting'
Description-Content-Type: text/markdown

# FoSpy
A framework for opening, editing, and saving Files of Synthesis (*.fos)
* [Main Github](https://github.com/errthumt/FoSpy)
* [GUI Proof of Concept](https://github.com/errthumt/CyFoS-alpha)
  * FOS syntax for the GUI alpha is an earlier iteration and may no longer be in use.


[Code Example](https://errthumt.github.io/FoSpy/examples/API_example/)

## A Simple FOS File

```fos
fos_id: TE001
fos_type: synthesis
// This comment will stay attached to the description when saving
// (Until comments are cleared)
description: My First Synthesis
group_id: kovnir-0000-0003-1152-1912
project_id: travis5672/clathrates/Ba2-TM5-Sb6

[Experimenters]
name: Travis Errthum
affiliation: Kovnir Group - Iowa State University
orcid: 0009-0006-1937-5672

// Single brackets on a header mean there is only one group
[Reaction]
nominal_formula: Ba2Zn5Sb6
nominal_amount: 250.0
nominal_amount_unit: milligram

[Products]
name: Barium Zinc Antimonide (2-5-6)
formula: Ba2Zn5Sb6
expected: True
obtained: True
expected_amount: 250.0
expected_amount_unit: milligram
obtained_amount: 200.0
obtained_amount_unit: milligram
observations: Black Powder
characterizations: PXRD, EDS, Eyeballs
structure_comments: Unique clathrate with novel polyhedra. Space group Pnma

// Double brackets on a header mean there are multiple similar groups
[Materials]
name: Barium
type: reagent
formula: Ba
supplier: Thermofisher
cas: 7440-39-3
form: lump
purity: 0.999
env: Ar (g)
// The comment below will be correctly re-calculated using a calc_routine
amount: 2.0
amount_unit: mol ratio
// Similar to headers, single brackets mean there is only one group,
// in this case for treatments of Barium
treatments: [
    type: cutting
    repeats: 1
    observations: smaller pieces improve homogenization
]

// This is a comment on the treatments block
[Treatments]

[[Cifs]]
file_name: attached.cif
path: projects/my_cifs

file_name: Ba2Zn5Sb6_ICSD.cif
embedded: {{{
['Embedded CIF Test Goes Here\n']
#################### END FOS EMBED }}}
```
