Skip to content

Commit

Permalink
Merge pull request #128 from DeMarcoLab/v0.2-dev
Browse files Browse the repository at this point in the history
v0.2.4 Release
  • Loading branch information
patrickcleeve2 authored Sep 22, 2023
2 parents c2d76a9 + b64ddad commit e806817
Show file tree
Hide file tree
Showing 55 changed files with 8,129 additions and 1,556 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ old_protocol/*.y*ml
old_protocol/*
dist/*
autolamella/db/fibsem.db
autolamella/liftout/log/*
58 changes: 9 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,64 +10,24 @@ AutoLamella is a python package for automated cryo-lamella preparation with focu

## Install

### Install OpenFIBSEM
Clone this repository:
### Recommended Installation Guide

Create a new virtual environment from the Anaconda Prompt terminal:
```
$ git clone https://github.com/DeMarcoLab/fibsem.git
```

Install dependencies and package
```bash
$ cd fibsem
$ conda env create -f environment.yml
$ conda create -n fibsem python=3.9 pip
$ conda activate fibsem
$ pip install -e .

$ pip install autolamella
```
### Install autolamella package
Clone this repository:
### Running Autolammela

```
$ git clone https://github.com/DeMarcoLab/autolamella.git
```

Install dependencies and package
```bash
$ conda activate fibsem
$ cd autolamella
$ pip install -e .
$ pip install pywin32==228
$ conda install -c conda-forge petname
Open the Anaconda Prompt terminal and run the following commands.

```
$ conda activate fibsem
$ autolamella_ui
### Install AutoScript
You will also need to install AutoScript 4.6+.

Please see the [Installation Guide](INSTALLATION.md) for detailed instructions.

Copy AutoScript /into home/user/miniconda3/envs/fibsem/lib/python3.9/site-packages/

### Install TESCAN Automation SDK

Ideally, please install and set up the conda environment first before proceeding to install this SDK

Run the Tescan-Automation-SDK-Installer-3.x.x.exe file

When asked for the python interpretor, select the existing conda environment for FIBSEM, if this python interpretor is not available, see detailed installation guide for a work around

See [Installation Guide](INSTALLATION.md) for full details


### Getting started
To run autolamella:
```bash
$ conda activate autolamella
$ autolamella
```
![UI](docs/img/ui.png)

![ui_new](docs/img/ui_new.png)

## Citation
If you find this useful, please cite our work.
Expand Down
13 changes: 8 additions & 5 deletions autolamella/config.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import os
from pathlib import Path

import autolamella

BASE_PATH: Path = os.path.dirname(__file__)
LOG_PATH: Path = os.path.join(BASE_PATH, 'log')
CONFIG_PATH: Path = os.path.join(BASE_PATH)
PROTOCOL_PATH: Path = os.path.join(BASE_PATH, "protocol", "protocol.yaml")
SYSTEM_PATH: Path = os.path.join(CONFIG_PATH, "system.yaml")

DESKTOP_SHORTCUT_PATH= os.path.dirname(autolamella.__path__[0])

EXPERIMENT_NAME = "AutoLamella"
HFW_THRESHOLD = 0.005 # 0.5% of the image height

__AUTOLAMELLA_METHODS__ = ["Autolamella-Default", "Autolamella-Waffle"]#, "Autoliftout-Default", "Autoliftout-Serial-Liftout"]

DEFAULT_PROTOCOL = {

"main_headers" : {
Expand All @@ -29,10 +31,9 @@
},

"lamella_headers" : {
"beam_shift_attempts": 3,
"alignment_attempts": 3,
"lamella_width": 10.e-6,
"lamella_length": 10.e-6,
"alignment_current": "Imaging Current",
},

"protocol_stage_1" : {
Expand Down Expand Up @@ -71,4 +72,6 @@


####### FEATURE FLAGS
_MINIMAP_VISUALISATION = True
_MINIMAP_VISUALISATION = True
_AUTO_SYNC_MINIMAP = True
_REGISTER_METADATA = True
72 changes: 0 additions & 72 deletions autolamella/depreceated/default_protocol.yaml

This file was deleted.

43 changes: 0 additions & 43 deletions autolamella/depreceated/protocol_bacteria.yaml

This file was deleted.

94 changes: 0 additions & 94 deletions autolamella/depreceated/protocol_converter.py

This file was deleted.

43 changes: 0 additions & 43 deletions autolamella/depreceated/protocol_ruby.yaml

This file was deleted.

5 changes: 5 additions & 0 deletions autolamella/liftout/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
try:
import importlib.metadata
__version__ = importlib.metadata.version('liftout')
except ModuleNotFoundError:
__version__ = "unknown"
Loading

0 comments on commit e806817

Please sign in to comment.