You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,14 +54,14 @@ and typing into a terminal window or Windows command prompt. It is
54
54
recommended that you consult online resources and become somewhat
55
55
familiar before using PDFmorph.
56
56
57
-
PDFmorph can be run with Python 2.7 and Python 3.5 or higher. We
57
+
PDFmorph can be run with Python 2.7 and Python 3.10 or higher. We
58
58
recommend using the Python 3 version. It makes use of several third party
59
59
libraries that you'll need to run the app and its components.
60
60
61
-
* NumPy - library for scientific computing with Python
62
-
* matplotlib - Python 2D plotting library
63
-
* SciPy - library for highly technical Python computing
64
-
* diffpy.utils - `shared helper utilities <https://github.com/diffpy/diffpy.utils/>`_ for wx GUI
61
+
* `NumPy` - library for scientific computing with Python
62
+
* `matplotlib` - Python 2D plotting library
63
+
* `SciPy` - library for highly technical Python computing
64
+
* `diffpy.utils` - `shared helper utilities <https://github.com/diffpy/diffpy.utils/>`_ for wx GUI
65
65
66
66
These dependencies will be installed automatically if you use the conda
67
67
installation procedure described below.
@@ -157,16 +157,14 @@ We welcome contributors from the community. Please consider posting issues, and
157
157
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
158
158
hooks.
159
159
160
-
1. modify the permissions to executable on the bash script called ``prevent_commit_to_main.sh`` in this directory: ``chmod +x prevent_commit_to_main.sh``
160
+
1. Install pre-commit in your working environment with ``conda install pre-commit``
161
161
162
-
2. install pre-commit in your working environment with ``conda install pre-commit``
163
-
164
-
3. initialize pre-commit (one time only) ``pre-commit install``
162
+
2. Initialize pre-commit (one time only) ``pre-commit install``
165
163
166
164
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
167
165
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
168
166
pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
0 commit comments