Initial
This commit is contained in:
80
README.md
Normal file
80
README.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# Quantum Entanglement Multi-Laboratory Study
|
||||
|
||||
## Non-local Correlations in Entangled Photon Pairs: A Multi-Laboratory Study of Bell Inequality Violations
|
||||
|
||||
This repository contains all data, analysis code, and manuscript materials for a collaborative study of Bell inequality violations across 34 quantum optics laboratories in 32 countries.
|
||||
|
||||
### Project Structure
|
||||
|
||||
```
|
||||
qu-en/
|
||||
├── data/
|
||||
│ ├── raw/ # Raw experimental data from participating labs
|
||||
│ └── base/ # Processed data files
|
||||
├── notebooks/ # Jupyter notebooks for analysis and visualization
|
||||
│ ├── make_basedata.ipynb # Data processing pipeline
|
||||
│ ├── plot_*.ipynb # Visualization notebooks
|
||||
│ ├── tab_*.ipynb # Table generation notebooks
|
||||
│ └── utils.py # Utility functions
|
||||
├── output/
|
||||
│ ├── plots/ # Generated figures
|
||||
│ ├── tables/ # Generated LaTeX tables
|
||||
│ └── manuscript.pdf # Final compiled manuscript
|
||||
├── report/
|
||||
│ └── manuscript.tex # LaTeX manuscript source
|
||||
├── Makefile # Build automation
|
||||
└── README.md
|
||||
```
|
||||
|
||||
### Building the Manuscript
|
||||
|
||||
The entire analysis pipeline and manuscript can be built with a single command:
|
||||
|
||||
```bash
|
||||
make
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Process raw experimental data
|
||||
2. Generate all plots and tables
|
||||
3. Compile the LaTeX manuscript to PDF
|
||||
|
||||
### Requirements
|
||||
|
||||
- Python 3.7+ with packages:
|
||||
- pandas
|
||||
- numpy
|
||||
- matplotlib
|
||||
- pyprojroot
|
||||
- papermill
|
||||
- jupyter
|
||||
- LaTeX distribution (e.g., TeXLive, MikTeX)
|
||||
- Make
|
||||
|
||||
### Data
|
||||
|
||||
The `data/raw/experimental_data.csv` file contains measurements from 35 participating laboratories (34 after quality control). Each row represents one experiment with the following key variables:
|
||||
|
||||
- Bell Parameter (S)
|
||||
- Entanglement Fidelity
|
||||
- Visibility
|
||||
- Detector specifications
|
||||
- Environmental conditions
|
||||
- And more...
|
||||
|
||||
### Reproducibility
|
||||
|
||||
All analysis is fully reproducible. The Makefile ensures correct execution order and dependency tracking. To rebuild from scratch:
|
||||
|
||||
```bash
|
||||
make clean
|
||||
make
|
||||
```
|
||||
|
||||
### License
|
||||
|
||||
Research data and code are provided for academic use. Please cite the accompanying publication if you use this data.
|
||||
|
||||
### Contact
|
||||
|
||||
For questions about the data or analysis, please contact the International Quantum Entanglement Consortium.
|
||||
Reference in New Issue
Block a user