-
Notifications
You must be signed in to change notification settings - Fork 19
skpkg: migrate documentation, README, and public static files #204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 10 commits
00f3e2b
d68e027
db42bc7
858d832
f08888f
8593a17
3d8f952
9422c9e
c83de82
5d231df
d0c2a2f
b397292
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| Authors | ||
| ======== | ||
| ======= | ||
|
|
||
| Billinge Group and community contributors. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| ============= | ||
| Release Notes | ||
| Release notes | ||
| ============= | ||
|
|
||
| .. current developments | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,14 @@ | ||
| |Icon| `diffpy.morph <https://diffpy.github.io/diffpy.morph>`_ | ||
| ============================================================== | ||
| |Icon| |title|_ | ||
| =============== | ||
|
|
||
| .. |title| replace:: diffpy.morph | ||
| .. _title: https://diffpy.github.io/diffpy.morph | ||
|
|
||
| .. |Icon| image:: https://avatars.githubusercontent.com/diffpy | ||
| :target: https://diffpy.github.io/diffpy.morph | ||
| :height: 100px | ||
|
|
||
| |PyPi| |Forge| |PythonVersion| |PR| | ||
| |PyPI| |Forge| |PythonVersion| |PR| | ||
|
|
||
| |CI| |Codecov| |Black| |Tracking| | ||
|
|
||
|
|
@@ -23,7 +26,7 @@ | |
|
|
||
| .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff | ||
|
|
||
| .. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.morph | ||
| .. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.morph | ||
| :target: https://pypi.org/project/diffpy.morph/ | ||
|
|
||
| .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.morph | ||
|
|
@@ -32,7 +35,7 @@ | |
| .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue | ||
| :target: https://github.com/diffpy/diffpy.morph/issues | ||
|
|
||
| Tools for manipulating and comparing PDF profiles | ||
| Python package for manipulating and comparing PDF profiles | ||
|
|
||
| ``diffpy.morph`` is a Python software package designed to increase the insight | ||
| 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`` | |
| conda create -n diffpy.morph_env diffpy.morph | ||
| conda activate diffpy.morph_env | ||
|
|
||
| To confirm that the installation was successful, type:: | ||
| To confirm that the installation was successful, type :: | ||
|
|
||
| python -c "import diffpy.morph; print(diffpy.morph.__version__)" | ||
|
|
||
| The output should print the latest version displayed on the badges above. | ||
| The output should print the latest version displayed on the badges above. | ||
|
|
||
| If the above does not work, you can use ``pip`` to download and install the latest release from | ||
| `Python Package Index <https://pypi.python.org>`_. | ||
| To install using ``pip`` into your ``diffpy.morph_env`` environment, we will also have to install dependencies :: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we shouldn't remove this block. In general, we don't want to remove things coming from the old package, unless it is something that is modified/improved in the new package. |
||
|
|
||
| pip install -r https://raw.githubusercontent.com/diffpy/diffpy.morph/main/requirements/pip.txt | ||
|
|
||
| and then install the package :: | ||
| To install using ``pip`` into your ``diffpy.morph_env`` environment, type :: | ||
|
||
|
|
||
| pip install diffpy.morph | ||
|
|
||
|
|
@@ -174,7 +173,7 @@ in a development mode, with its sources being directly used by Python | |
| rather than copied to a package directory, use the following in the root | ||
| directory :: | ||
|
|
||
| pip install -e . | ||
| pip install -e . | ||
|
|
||
| To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit | ||
| hooks. | ||
|
|
@@ -195,4 +194,9 @@ Before contributing, please read our `Code of Conduct <https://github.com/diffpy | |
| Contact | ||
| ------- | ||
|
|
||
| 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. | ||
| For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at sb2896@columbia.edu. | ||
|
|
||
| Acknowledgements | ||
| ---------------- | ||
|
|
||
| ``diffpy.morph`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need this to be 2024-2025