New piec time

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+sphinx:
+    configuration: docs/source/conf.py
+    fail_on_warning: false
+
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: "3.8"
+   install:
+   - requirements: docreqs.txt

CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+message: Please cite this software using these metadata.
+authors:
+  - family-names: Fratian
+    given-names: Geo, George
+    email: [email protected]
+    affiliation: Brown University
+    orcid: 'https://orcid.org/0009-0008-2687-671X'
+title: piec
+type: software
+version: 0.0.01
+url: https://github.com/ElPsyKurisu/PIEC

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Geo Fratian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,5 @@
+# PIEC
+ Python Integrated Experimental Control
+ The goal of this repository is to provide a streamlined control scheme for lab experiments and allow for rapid development
+ of new experimental procedures starting from a ferroelectric standpoint.
+ Requires KEYSIGHT I/O Libraries, find them here: www.keysight.com/find/iosuite

docreqs.txt

@@ -0,0 +1,6 @@
+pandas>=1.3.2
+numpy>=1.19.2
+matplotlib>=3.3.4
+scipy>=1.6.2
+pyvisa>=1.11.3
+IPython>=7.22.0

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,30 @@
+[metadata]
+name = piec
+version = attr: piec._version.__version__
+author = Geo Fratian
+author_email = [email protected]
+description = A collection of control and analysis code for experiments
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/ElPsyKurisu/piec 
+project_urls =
+    Bug Tracker = https://github.com/ElPsyKurisu/piec/issues
+	repository = https://github.com/ElPsyKurisu/piec
+classifiers =
+    Programming Language :: Python :: 3
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+
+[options]
+package_dir =
+    = src
+packages = find:
+include_package_data = True
+install_requires = file: docreqs.txt
+python_requires = >=3.6
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+* = *_notebook.ipynb

setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

src/piec/__init__.py

@@ -0,0 +1,3 @@
+from ._version import __version__
+
+__all__ = ('__version__')

src/piec/_version.py

@@ -0,0 +1 @@
+__version__ = '0.0.01-beta3'

src/piec/analysis/README.md

@@ -0,0 +1,2 @@
+# Analysis
+ Code to analyze, feel free to put a summary here no

src/piec/drivers/README.md

@@ -0,0 +1,2 @@
+# Drivers
+ Instrument drivers centered around an Instrument class structured with all insturments inheriting from a generic instrument class and then subdividing into sub-classes based on instrument charectoristics

src/piec/drivers/__init__.py

@@ -0,0 +1,2 @@
+from .instrument import *
+from pymeasure.instruments import*