File tree 2 files changed +32
-7
lines changed
2 files changed +32
-7
lines changed Original file line number Diff line number Diff line change @@ -59,7 +59,6 @@ by citing the following paper in your publication:
59
59
<https://doi.org/10.1038/s41524-024-01377-5> `__,
60
60
*npj Comput Mater * **10 **, 193 (2024).
61
61
62
-
63
62
Installation
64
63
------------
65
64
@@ -77,6 +76,12 @@ The following creates and activates a new environment named ``diffpy.snmf_env``
77
76
conda create -n diffpy.snmf_env diffpy.snmf
78
77
conda activate diffpy.snmf_env
79
78
79
+ To confirm that the installation was successful, type ::
80
+
81
+ python -c "import diffpy.snmf; print(diffpy.snmf.__version__)"
82
+
83
+ The output should print the latest version displayed on the badges above.
84
+
80
85
If the above does not work, you can use ``pip `` to download and install the latest release from
81
86
`Python Package Index <https://pypi.python.org >`_.
82
87
To install using ``pip `` into your ``diffpy.snmf_env `` environment, type ::
@@ -89,13 +94,10 @@ and run the following ::
89
94
90
95
pip install .
91
96
92
- To confirm that the installation was successful, type ::
93
-
94
- python -c "import diffpy.snmf; print(diffpy.snmf.__version__)"
95
-
96
- The output should print the latest version displayed on the badges above.
97
+ Getting Started
98
+ ---------------
97
99
98
- Now, you may consult our `online documentation <https://diffpy.github.io/diffpy.snmf >`_ for tutorials and API references.
100
+ You may consult our `online documentation <https://diffpy.github.io/diffpy.snmf >`_ for tutorials and API references.
99
101
100
102
Support and Contribute
101
103
----------------------
Original file line number Diff line number Diff line change
1
+ **Added: **
2
+
3
+ * <news item>
4
+
5
+ **Changed: **
6
+
7
+ * <news item>
8
+
9
+ **Deprecated: **
10
+
11
+ * <news item>
12
+
13
+ **Removed: **
14
+
15
+ * <news item>
16
+
17
+ **Fixed: **
18
+
19
+ * Add getting started section and re-arrange install success check instructions
20
+
21
+ **Security: **
22
+
23
+ * <news item>
You can’t perform that action at this time.
0 commit comments