Skip to content

Commit db42bc7

Browse files
committed
skpkg: add README.rst
1 parent d68e027 commit db42bc7

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
|Icon| `diffpy.morph <https://diffpy.github.io/diffpy.morph>`_
2-
==============================================================
1+
|Icon| |title|_
2+
===============
3+
4+
.. |title| replace:: diffpy.morph
5+
.. _title: https://diffpy.github.io/diffpy.morph
36

47
.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
58
:target: https://diffpy.github.io/diffpy.morph
69
:height: 100px
710

8-
|PyPi| |Forge| |PythonVersion| |PR|
11+
|PyPI| |Forge| |PythonVersion| |PR|
912

1013
|CI| |Codecov| |Black| |Tracking|
1114

@@ -23,7 +26,7 @@
2326

2427
.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
2528

26-
.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.morph
29+
.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.morph
2730
:target: https://pypi.org/project/diffpy.morph/
2831

2932
.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.morph
@@ -32,7 +35,7 @@
3235
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
3336
:target: https://github.com/diffpy/diffpy.morph/issues
3437

35-
Tools for manipulating and comparing PDF profiles
38+
Python package for manipulating and comparing PDF profiles
3639

3740
``diffpy.morph`` is a Python software package designed to increase the insight
3841
researchers can obtain from measured atomic pair distribution functions
@@ -107,19 +110,15 @@ The following creates and activates a new environment named ``diffpy.morph_env``
107110
conda create -n diffpy.morph_env diffpy.morph
108111
conda activate diffpy.morph_env
109112

110-
To confirm that the installation was successful, type::
113+
To confirm that the installation was successful, type ::
111114

112115
python -c "import diffpy.morph; print(diffpy.morph.__version__)"
113116

114-
The output should print the latest version displayed on the badges above.
117+
The output should print the latest version displayed on the badges above.
115118

116119
If the above does not work, you can use ``pip`` to download and install the latest release from
117120
`Python Package Index <https://pypi.python.org>`_.
118-
To install using ``pip`` into your ``diffpy.morph_env`` environment, we will also have to install dependencies ::
119-
120-
pip install -r https://raw.githubusercontent.com/diffpy/diffpy.morph/main/requirements/pip.txt
121-
122-
and then install the package ::
121+
To install using ``pip`` into your ``diffpy.morph_env`` environment, type ::
123122

124123
pip install diffpy.morph
125124

@@ -165,16 +164,14 @@ Enjoy!
165164
Support and Contribute
166165
----------------------
167166

168-
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.morph. Please join the diffpy.morph users community by joining the Google group. The diffpy.morph project welcomes your expertise and enthusiasm!
169-
170-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.morph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.morph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
167+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.morph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.morph/pulls>`_.
171168

172169
Feel free to fork the project and contribute. To install diffpy.morph
173170
in a development mode, with its sources being directly used by Python
174171
rather than copied to a package directory, use the following in the root
175172
directory ::
176173

177-
pip install -e .
174+
pip install -e .
178175

179176
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
180177
hooks.
@@ -195,4 +192,9 @@ Before contributing, please read our `Code of Conduct <https://github.com/diffpy
195192
Contact
196193
-------
197194

198-
For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.
195+
For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at simon.billinge@gmail.com.
196+
197+
Acknowledgements
198+
----------------
199+
200+
``diffpy.morph`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.

0 commit comments

Comments
 (0)