Skip to content

Commit deed9ee

Browse files
authored
Update installation instruction plus minor autoconfig fix (#164)
* You cannot `get_data_from_shared_memory` if data is an error report * Add infor about OS, installation, PyCifRW * Fix a long-standing typo in autoconfig
1 parent b4ec6c7 commit deed9ee

2 files changed

Lines changed: 7 additions & 4 deletions

File tree

readme.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ See [instamatic-dev/instamatic-tecnai-server](https://github.com/instamatic-dev/
3434

3535
## Installation
3636

37-
If you use conda, create a new environment:
37+
If you use conda, create a new environment with a supported version of python. For maximum convenience, install basic libraries as well as `pycifrw` from conda forge:
3838

3939
```
40-
conda create -n instamatic python=3.11
40+
conda create -n instamatic python=3.12
4141
conda activate instamatic
42+
conda install numpy matplotlib pycifrw -c conda-forge
4243
```
4344

4445
Install using pip, works with python versions 3.9 or newer:
@@ -47,9 +48,11 @@ Install using pip, works with python versions 3.9 or newer:
4748
pip install instamatic
4849
```
4950

51+
Please mind that one of the indirect Instamatic dependencies, PyCifRW, requires Microsoft Visual C++ 14.0 or greater to compile properly. For this reason, when installing instamatic directly from pip, these build tools must be available on the system to succeed. Installing precompiled `pycifrw` from conda-forge circumvents this issue.
52+
5053
## OS requirement
5154

52-
The package requires Windows 7 or higher. It has been mainly developed and tested under Windows 7 and higher.
55+
The package requires Windows 7 or higher. It has been mainly developed and tested under Windows 7 and higher. Client and camera server installation were shown to successfully run on Unix-based systems but may require additional care. Microscope server installations require Windows OS for communication with the TEM.
5356

5457
## Package dependencies
5558

src/instamatic/config/autoconfig.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ def main():
206206
print(f' 1. Check and update the pixelsizes in `{calib_config_fn}`')
207207
print(' - In real space, pixelsize in nm')
208208
print(' - In reciprocal space, pixelsize in px/Angstrom')
209-
print(f' 2. Check and update magnification ranges in `{microscope_config_fn}`')
209+
print(f' 2. Check and update magnification ranges in `{tem_config_fn}`')
210210

211211

212212
if __name__ == '__main__':

0 commit comments

Comments
 (0)