Merge branch 'main' of github.com:tomotools/subtomotools

.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        python -m pip install ./
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

README.md

@@ -2,10 +2,10 @@
 Scripts to facilitate STA, interfacing Warp/M, Relion 3.1, TomoTwin and whatever else seems relevant. 
 
 ## Functions:
-```upgrade-star```: Upgrade Warp-style star to Relion 3.1.4
-```downgrade-star```: Downgrade Relion-3-style star to Warp/M
+```upgrade-star```: Upgrade Warp-style star to Relion 3.1.4  
+```downgrade-star```: Downgrade Relion-3-style star to Warp/M  
 
-```project-particles```: Calculate 2D projections of subtomograms, with or without CTF correction.
+```project-particles```: Calculate 2D projections of subtomograms, with or without CTF correction. CTF correction requires CTF volume.  
 ```apply-subset```: Apply subset of particles from 2D classification to subtomogram star.
 
 ```tomotwin2warp```: **not included yet**, will be conversion of a tomotwin-generated coords directory to a Warp-style star