Giter Club home page Giter Club logo

pycaf's Introduction

PyCaF

Automated experimentation along with data analysis with Python

This repository contains Python code for data analysis tasks using popular libraries like Pandas, NumPy, and Matplotlib. The purpose of this project is to showcase different data analysis techniques and provide examples that can be used as a reference.

Getting Started

To get started, install anaconda in your system.

Clone this repository

git clone https://github.com/ColdMatter/pycaf.git

Then create a new environment using the command

conda create -f environment.yml

After creating the environment activate the environment using

conda activate pycaf

Navigate to the pycaf directory

cd \your_path\pycaf

Here install pycaf in editable mode using the command:

pip install -e .

Dependencies

The main libraries used in this project are:

  • Pythonnet: Used for the python to C# bridge.
  • NumPy: Used for numerical computing.
  • Matplotlib: Used for creating visualizations.
  • Plotly: Used for better interactive visualization.

Contributing

If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request. Contributions are welcome and encouraged!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

We would like to acknowledge the open-source community for creating and maintaining the essential Python libraries used in this project. Their efforts make data analysis with Python accessible and efficient for everyone.

Example Configuration file setup

{
    "edmsuite_modules":
        {
            "MOTMaster":
                {
                    "exe_path": "C:\\ControlPrograms\\EDMSuite\\MOTMaster\\bin\\CaFBEC\\MOTMaster.exe",
                    "remote_paths":
                        {
                            "bay_2": "tcp://localhost:1187/controller.rem",
                            "bay_3": "tcp://x.x.x.x:1187/controller.rem"
                        }
                },
            "WavemeterLock":
                {
                    "exe_path": "C:\\ControlPrograms\\EDMSuite\\WavemeterLock\\bin\\CaFBEC\\WavemeterLock.exe",
                    "remote_paths": 
                        {
                            "bay_2": "tcp://localhost:1234/controller.rem",
                            "bay_3": "tcp://x.x.x.x:5555/controller.rem"
                        },
                    "lasers":
                        {
                            "bay_2": ["v00", "BX", "v10", "v21", "v32"],
                            "bay_3": ["TCool"]
                        }
                },
            "CaFBECHadwareController":
                {
                    "exe_path": "C:\\ControlPrograms\\EDMSuite\\CaFBECHadwareController\\bin\\CaFBEC\\CaFBECHadwareController.exe",
                    "remote_paths":
                        {
                            "bay_2": "tcp://localhost:1172/controller.rem"
                        }
                },
            "TransferCavityLock2012":
                {
                    "exe_path": "C:\\ControlPrograms\\EDMSuite\\TransferCavityLock2012\\bin\\CaFBEC\\TransferCavityLock.exe",
                    "remote_paths":
                        {
                            "bay_2": "tcp://localhost:1190/controller.rem"
                        },
                    "lasers": {}
                }
        },
    "edmsuite_dlls":
        {
            "daq": "C:\\ControlPrograms\\EDMSuite\\DAQ\\bin\\CaF\\DAQ.dll",
            "shared_code": "C:\\ControlPrograms\\EDMSuite\\SharedCode\\bin\\CaFBEC\\SharedCode.dll"
        },
    "plugin_modules":
        {
            "picomotor":
                {
                    "type": "pre",
                    "connect": false,
                    "defaults": {
                        "motor": "CMH",
                        "speed": 50,
                        "acceleration": 10,
                        "steps": 10,
                        "max_steps": 300
                    },
                    "motor_to_axis":
                        {
                            "FMH": 1,
                            "FMV": 2,
                            "CMH": 3,
                            "CMV": 4,
                            "Further Mirror Horizontal": 1,
                            "Further Mirror Vertical": 2,
                            "Closer Mirror Horizontal": 3,
                            "Closer Mirror Vertical": 4
                        }
                },
            "evalboard_ad9959": {},
            "picoscope": {},
            "pfeiffer":
                {
                    "serial_port": "COM23",
                    "baud_rate": 9600,
                    "description": {
                        "1": "Source backing",
                        "2": "Science chamber backing",
                        "3": "Not In Use",
                        "4": "Source",
                        "5": "Beamline",
                        "6": "Science chamber"
                    }
                },
            "lakeshore":
                {
                    "serial_port": "COM12",
                    "baud_rate": 57600,
                    "description": {
                        "0": "Cell",
                        "1": "4K",
                        "2": "SF6-4K",
                        "3": "40K",
                        "4": "SF6-40K",
                        "5": "Top Coil",
                        "6": "Jacket",
                        "7": "Cold head"
                    },
                    "sensor-id": {
                        "0": "A",
                        "1": "B",
                        "2": "C",
                        "3": "D1",
                        "4": "D2",
                        "5": "D3",
                        "6": "D4",
                        "7": "D5"
                    }
                }
        },
    "script_root_path": "C:\\ControlPrograms\\EDMSuite\\BECMOTMasterScripts",
    "data_root_path": "E:\\mot_master_data",
    "temp_image_path": "C:\\Users\\cafmot\\Documents\\Temp_camera_images",
    "temp_tof_path": "C:\\Users\\cafmot\\Documents\\ToF_Data",
    "temp_wavemeter_info_path": "C:\\Users\\cafmot\\Documents\\ToF_Data",
    "data_prefix": "CaFBEC",
    "default_remote_path_id": "bay_2",
    "constants":
        {
            "full_well_capacity": 140000.0,
            "bits_per_channel": 16.0,
            "gamma": 1.5e6,
            "collection_solid_angle": 0.016,
            "eta_q": 0.92,
            "magnification": 1.42,
            "pixel_size": 16e-6,
            "photon_to_electron": 2.2,
            "binning": 4,
            "cs_exposure_time_parameter": "CameraTriggerDuration"
        }
}

Example api usage

Create the experiment and probe object

import numpy as np
import datetime
import pycaf

today = datetime.date.today()
config_path = "C:\\ControlPrograms\\pycaf\\config_bec.json"

expt = pycaf.Experiment(config_path=config_path, interval=0.1)
probe = pycaf.Probe(config_path, today.year, today.month, today.day)

Run an experimet

expt.scan(
    script="MOTBasic",
    motmaster_parameters_with_values={
        "yagONorOFF": [10.0, 1.0]
    },
    lasers_with_frequencies={
        "v00": np.arange(494.431850, 494.431880, 0.000003).tolist()
    },
    n_iter=10
)

Analyse the experimental data

probe.number_by_image(
    0, 10, "CameraTriggerStart",
    row_start=40, row_end=70,
    col_start=40, col_end=70,
    xscale=1e-2,
    yscale=1.0,
    xlabel="CameraTriggerStart [ms]",
    ylabel="Molecule number",
    display_images=True,
    grid=False,
    show_roi=False
)

pycaf's People

Contributors

lyuqinshu avatar

Watchers

Jony Hudson avatar  avatar  avatar  avatar Teodor Krastev avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.