mirror of
https://github.com/c-sooyoung/bo-ptycho.git
synced 2026-09-17 17:19:08 +09:00
added README and license
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
Copyright (c) 2026 Sooyoung Cheong
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,26 @@
|
||||
# bo-ptycho
|
||||
|
||||
This code is a (re)implementation of Bayesian Optimized ptychography in python for use at LEMON lab, used for
|
||||
|
||||
- Optimization-based Thickness Estimation and FIB-induced Damage Characterization of TEM Sample via Multislice Electron Ptychography (manuscript)
|
||||
|
||||
|
||||
|
||||
## Code usage
|
||||
|
||||
Prerequisites:
|
||||
1. Create a python virtual environment with [requirements.txt](./requirements.txt)
|
||||
2. Download [fold_slice](#)
|
||||
2. Download [experimental data](#)
|
||||
|
||||
Reconstruction and parameter optimization:
|
||||
1. Edit [config.yaml](./config.yaml)
|
||||
- Example configurations can be found under `examples/silicon-fib/`
|
||||
- Set io.input_data_path and io.result_dir as needed (WARNING: the result directory will be completely removed)
|
||||
- Set ptycho.path to your fold_slice path
|
||||
2. Edit [job.sub](./job.sub)
|
||||
- Set the SBATCH configurations as needed (especially `gres` and `output`)
|
||||
- The number of GPUs should match bo.batch in config.yaml
|
||||
- Set the virtual environment path
|
||||
- Set the config.yaml path
|
||||
3. Submit the job via SLURM
|
||||
Reference in New Issue
Block a user