Skip to content

Commit

Permalink
Merge branch 'dev' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
@bsavitzky
bsavitzky authored May 27, 2024
2 parents 237efa4 + d6cd7a9 commit 83d45d4
Show file tree
Hide file tree
Showing 26 changed files with 752 additions and 421 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
fetch-depth: 0

- name: Lint Code Base
uses: github/super-linter@v5
uses: github/super-linter@v6
env:
VALIDATE_ALL_CODEBASE: false
VALIDATE_PYTHON_FLAKE8: true
Expand Down
64 changes: 32 additions & 32 deletions docs/source/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Windows
:linenos:
:caption: Windows base install
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
conda install -c conda-forge pywin32
Expand All @@ -59,7 +59,7 @@ Linux
:caption: Linux base install
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
# optional but recomended
Expand All @@ -72,7 +72,7 @@ Mac (Intel)
:caption: Intel Mac base install
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
# optional but recomended
Expand All @@ -86,9 +86,9 @@ Mac (Apple Silicon M1/M2)
:caption: Apple Silicon Mac base install
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install pyqt hdf5
conda install -c conda-forge pyqt hdf5
conda install -c conda-forge py4dstem
# optional but recomended
conda install jupyterlab pymatgen
Expand All @@ -112,7 +112,7 @@ Windows
:linenos:
:caption: Windows Anaconda install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem pymatgen
conda install -c conda-forge pywin32
Expand All @@ -123,7 +123,7 @@ Running py4DSTEM code with GPU acceleration requires an NVIDIA GPU (AMD has beta
:linenos:
:caption: Windows Anaconda install GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem cupy cudatoolkit
conda install -c conda-forge pywin32
Expand All @@ -135,7 +135,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Windows Anaconda install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
pip install tensorflow==2.4.1 tensorflow-addons<=0.14 crystal4D
Expand All @@ -145,7 +145,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Windows Anaconda install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
conda install -c conda-forge cupy cudatoolkit=11.0
Expand All @@ -161,7 +161,7 @@ Linux
:linenos:
:caption: Linux Anaconda install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem pymatgen
Expand All @@ -171,7 +171,7 @@ Running py4DSTEM code with GPU acceleration requires an NVIDIA GPU (AMD has beta
:linenos:
:caption: Linux Anaconda install GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem cupy cudatoolkit
Expand All @@ -182,7 +182,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Linux Anaconda install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
pip install tensorflow==2.4.1 tensorflow-addons<=0.14 crystal4D
Expand All @@ -191,7 +191,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Linux Anaconda install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
conda install -c conda-forge cupy cudatoolkit=11.0
Expand All @@ -205,7 +205,7 @@ Mac (Intel)
:linenos:
:caption: Intel Mac Anaconda install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem pymatgen
Expand All @@ -216,7 +216,7 @@ Tensorflow does not support AMD GPUs so while ML-AI features can be run on an In
:linenos:
:caption: Intel Mac Anaconda install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
pip install tensorflow==2.4.1 tensorflow-addons<=0.14 crystal4D
Expand All @@ -227,7 +227,7 @@ Mac (Apple Silicon M1/M2)
:linenos:
:caption: Apple Silicon Mac Anaconda install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem pymatgen
Expand All @@ -239,7 +239,7 @@ Tensorflow's support of Apple silicon GPUs is limited, and while there are steps
:linenos:
:caption: Apple Silicon Mac Anaconda install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge py4dstem
pip install tensorflow==2.4.1 tensorflow-addons<=0.14 crystal4D
Expand All @@ -254,7 +254,7 @@ Tensorflow's support of Apple silicon GPUs is limited, and while there are steps
:caption: Apple Silicon Mac Anaconda install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c apple tensorflow-deps
pip install tensorflow-macos==2.5.0 tensorflow-addons<=0.14 crystal4D tensorflow-metal
Expand All @@ -272,7 +272,7 @@ Windows
:linenos:
:caption: Windows pip install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[acom]
conda install -c conda-forge pywin32
Expand All @@ -283,7 +283,7 @@ Running py4DSTEM code with GPU acceleration requires an NVIDIA GPU (AMD has beta
:linenos:
:caption: Windows pip install GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[cuda]
conda install -c conda-forge pywin32
Expand All @@ -295,7 +295,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Windows pip install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[aiml]
conda install -c conda-forge pywin32
Expand All @@ -304,7 +304,7 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Windows pip install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge cudatoolkit=11.0
pip install py4dstem[aiml-cuda]
Expand All @@ -317,7 +317,7 @@ Linux
:linenos:
:caption: Linux pip install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[acom]
Expand All @@ -327,7 +327,7 @@ Running py4DSTEM code with GPU acceleration requires an NVIDIA GPU (AMD has beta
:linenos:
:caption: Linux pip install GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[cuda]
Expand All @@ -338,15 +338,15 @@ If you are looking to run the ML-AI features you are required to install tensorf
:linenos:
:caption: Linux pip install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[aiml]
.. code-block:: shell
:linenos:
:caption: Linux pip install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c conda-forge cudatoolkit=11.0
pip install py4dstem[aiml-cuda]
Expand All @@ -357,7 +357,7 @@ Mac (Intel)
:linenos:
:caption: Intel Mac pip install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[acom]
Expand All @@ -368,7 +368,7 @@ Tensorflow does not support AMD GPUs so while ML-AI features can be run on an In
:linenos:
:caption: Intel Mac pip install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[aiml]
Expand All @@ -378,7 +378,7 @@ Mac (Apple Silicon M1/M2)
:linenos:
:caption: Apple Silicon Mac pip install ACOM
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[acom]
conda install -c conda-forge py4dstem pymatgen
Expand All @@ -391,7 +391,7 @@ Tensorflow's support of Apple silicon GPUs is limited, and while there are steps
:linenos:
:caption: Apple Silicon Mac Anaconda install ML-AI CPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
pip install py4dstem[aiml]
Expand All @@ -405,7 +405,7 @@ Tensorflow's support of Apple silicon GPUs is limited, and while there are steps
:caption: Apple Silicon Mac Anaconda install ML-AI GPU
conda create -n py4dstem python=3.9
conda create -n py4dstem python=3.11
conda activate py4dstem
conda install -c apple tensorflow-deps
pip install tensorflow-macos==2.5.0 tensorflow-addons<=0.14 crystal4D tensorflow-metal py4dstem
Expand Down Expand Up @@ -477,7 +477,7 @@ Virtual Environments

A Python virtual environment is its own siloed version of Python, with its own set of packages and modules, kept separate from any other Python installations on your system.
In the instructions above, we created a virtual environment to make sure packages that have different dependencies don't conflict with one another.
For instance, as of this writing, some of the scientific Python packages don't work well with Python 3.9 - but you might have some other applications on your computer that *need* Python 3.9.
For instance, as of this writing, some of the scientific Python packages don't work well with Python 3.11 - but you might have some other applications on your computer that *need* Python 3.11.
Using virtual environments solves this problem.
In this example, we're creating and navigating virtual environments using Anaconda.

Expand Down
Loading

0 comments on commit 83d45d4

Please sign in to comment.