In order to use Python you need at least an installation of Python and an Editor which allows you to comfortably edit your scripts.
Go to https://www.python.org/downloads/ and download the latest release of python. Important: During the installation, check the box "Add Python to PATH", press -> Customize Installation and make sure that "pip" will be installed. Further it's recommended to use the "Install for all users" option.
This lets you easily switch between multiple versions of Python. For more information see https://github.com/pyenv/pyenv. As an installer, https://github.com/pyenv/pyenv-installer is recoommended. A full set of commands can be found under https://github.com/pyenv/pyenv/blob/master/COMMANDS.md.
Visual Studio Code is a lightweight but powerful source code editor to setup your Python Environment. It has a rich ecosystem of useful extensions.
If you use Visual Studio code, you might also want to install the following extensions with it:
- Python - In order to use Python in VS
- Todo Tree - Create & edit To-Do Lists in VS
- GitHub Pull Requests and Issues - GitHub integration in VS
- CodeStream - Collaboration, code discussion and review (Sign in with GitHub)
- GitLens — Git supercharged -> Tracking GitHub changes (Sign in with GitHub)
- Pylance - Additional Python language support
- Visual Studio IntelliCode -> Offers autocomplete of syntax
- autoDocstring - Python Docstring Generator -> Helps you to generate docstrings to document your code
- LaTeX Workshop - Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more. In order to use LaTeX Enginge, e.g. TinyTeX is required.
In order to use GitHub within Visual Studio Code, you need to install "git" as well (https://git-scm.com/downloads). Here you can leave all settings in the installation as they are proposed.
Further you might want to use linting, therefore in VS, open the command bar (Ctrl+Shift+P), type "Python: Select Linter", confirm with enter and select "pylint"
Moreover, for simple PEP-Style conform code formatting, you can use a formatter. Therefore install one with "pip install autopep8". In VS, under Settings search for python.formatting.provider and select autopep8. To use the formatter on your code, open the command bar (Ctrl+Shift+P), type "Format:" and select the desired option.
In order to use the same settings for Visual Studio Code on all of your computers, activate "Settings Sync": Open the command bar (Ctrl+Shift+P), type "Settings Sync: Turn On, confirm with enter and select e.g. your GitHub account. See also https://code.visualstudio.com/docs/editor/settings-sync.
See also https://www.youtube.com/watch?v=TILIcrrVABg for a VS complete guide
Sourcetrail can be used for code search and dependency visualization that lets you understand, refactor and maintain unfamiliar source code. It analyzes code and provides a graphical overview of the code.
See https://www.sourcetrail.com/ for more details.
Nota: Sourcetrail requires jedi. Currently jedi seems to depend on Python 3.8. Install Python 3.8 and under "Python Environment" in your Sourcetrail project specify the Python environment (e.g. C:/Program Files/Python38)
See "./sampleCode" for an exemplary code structure as we recommend it.
A helper function is a function which is used frequently in different scripts that performs part of the computation of another function. Helper functions are used to make your programs easier to read by giving descriptive names to computations. They also let you reuse computations, just as with functions in general.
See also README.md for further information
Inkscape is an open-source vector graphics editing program. It can be eg. used to make sketches and static drawings. Find here templates and additional scripts.
See also README.md for further information
For each plot (lineplots, histograms, bar charts...) a different function simplyfing the process of plotting is used. See also README.md for further information
This simple project is an example for the structure of Python code @ILEK. Simply copy it and customize according to your needs.
See also README.md for further information
The sample also contains an example for a simple gui (graphical user interface) using PyQt5 which can be copied and customized according to your needs.
See also README.md for further information
Code snippets are templates that make it easier to enter repeating code patterns, such as loops or conditional-statements. See also https://code.visualstudio.com/docs/editor/userdefinedsnippets.
The below mentioned templates and some basic snippets can be found within pyLEK/snippets. Place them in C:\Users"Username"\AppData\Roaming\Code\User\snippets to globally enable them.
When adding new functions always respect the following template and the style guideline. Otherwise you're file will be removed. Keep the functions simple, short and comment when necessary.
# -*- coding: utf-8 -*-
# ------------------------------------------------------------------------------
# Description: ** Add here short description **
# Author: ** Add here author's e-mail adress **
# Created: ** Add here the date of creation **
# Execution: Import functions / collections (from pyLek.helpers import util)
# ------------------------------------------------------------------------------
# ------------------------------------------------------------------------------
# Sources
# ------------------------------------------------------------------------------
# https://stackoverflow.com/questions/16819222/how-to-return-dictionary-keys-as-a-list-in-python
# ------------------------------------------------------------------------------
# Libraries
# ------------------------------------------------------------------------------
# Example
import scipy.io
# ------------------------------------------------------------------------------
# Functions
# ------------------------------------------------------------------------------
# Example, see pyExtras.py
def getList(dict: _type_): # Note the type hint with ": _type_"
"""
_summary_ # Brief description of function, see
# https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
:param dict: _description_ # Description of input
:return: _description_ # Description of return
:rtype: _type_ # Type of return
"""
return dict.keys() # Actual Function statements
def sample(): # Sample of the function
pass
if __name__ == "__main__":
sample()
https://www.python.org/dev/peps/pep-0008/
-
Add the path of this folder (e.g. if the pyLEK folder is located under C:\Users\ac123456\GitHub\pyLEK use the path C:\Users\ac123456\GitHub) to PYTHONPATH (Umgebungsvariable -> Nutzervariablen). Now you don't have to add the full path for import statements. https://stackoverflow.com/questions/3701646/how-to-add-to-the-pythonpath-in-windows-so-it-finds-my-modules-packages
-
import modules, z.B: from pyLEK.helpers import pyExtras
Ignored files are usually build artifacts and machine generated files that can be derived from your repository source or should otherwise not be committed. Some common examples are:
- dependency caches, such as the contents of /node_modules or /packages
- compiled code, such as .o, .pyc, and .class files
- build output directories, such as /bin, /out, or /target
- files generated at runtime, such as .log, .lock, or .tmp
- hidden system files, such as .DS_Store or Thumbs.db
- personal IDE config files, such as .idea/workspace.xml
Ignored files are tracked in a special file named .gitignore that is checked in at the root of your repository. There is no explicit git ignore command: instead the .gitignore file must be edited and committed by hand when you have new files that you wish to ignore. .gitignore files contain patterns that are matched against file names in your repository to determine whether or not they should be ignored.
.gitignore also offers support for custom files. All files named with the prefix custom, eg "custom_plot2D.py" will be ignored for upload but will remain on your local machine. Saying you want to create your own plot2D.py, just copy the file and rename it as "custom_plot2D.py", and it will not be uploaded to the repository.
The repository is using linked repositories created by other authors. In order to setup new submodules check out https://git-scm.com/book/en/v2/Git-Tools-Submodules
When cloning the pyLEK-Repo, by default you get the directories that contain submodules, but none of the files within them yet.
Too pull submodules, from the root of the repo just run <git submodule init> to initialize your local configuration file, and <git submodule update> to fetch all the data from that project.
Submodules are linked to a certain commit of the submodule. In case the submodule has been updated, the link in the project has to be updated manually. In order to do so, execute <git submodule update --remote --merge> from the project folder.
The ILEK-LaTeX template for theses, see https://github.com/Silaxer/Vorlage_Abschlussarbeiten
In order to use just copy the folder.
Structural finite element analysis, the pythonic way, see https://github.com/robbievanleeuwen/feastruct/
In order to use the module:
- Open "cmd" as Administrator
- With "cd" navigate to your local GitHub-Folder (e.g. C:\Users\Username\GitHub\pyLEK\feastruct)
- Install with py setup.py install
For the usage check out feastruct/examples
In order to delete the repository from your local machine, simply delete the folder. Make sure you uploaded all your changes before deleting.
You can delete the folder in the windows explorer, or better, using git-bash (https://gitforwindows.org/), navigate to your folder, and use the command rm-rf Name_of_your_repo