Skip to content

docs: add the instruction to reinstall pycifrw#145

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.

Sign up for GitHub

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

Closed
ycexiao wants to merge 1 commit into from
Closed

docs: add the instruction to reinstall pycifrw#145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,10 @@ and run the following ::

pip install .

In ``diffpy.structure>=3.3.1``, please ensure the dependency ``pycifrw`` is installed from ``conda-froge`` ::
Copy link
Contributor

@sbillingesbillingeJul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do a bit more checking. Are the PyPI and conda version numbers the same? if not, then it could be a version number issue. and the instructions would be to install pycifrw>=??? or pycifrw<=??. If the version is the same on PyPI and conda-forge, let the users know that explicitly (the conda-forge one works but the PyPI one doesn't).

We can also check to see if we can update our tests so it passes with both versions too.

Let's discuss it, but we can also propose to make an issue/PR at pycifrw.


conda install pycifrw

Getting Started
---------------

Expand Down
23 changes: 23 additions & 0 deletions news/reinstall-pycifrw.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
**Added:**

* Add the instruction to reinstsall ``pycifrw`` in ``README.rst``.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading